Servant.Hateoas.Resource

ResourceLink

data ResourceLink

Type for Hypermedia-Links.

Constructors

CompleteLink Link

A complete Link with all information.

TemplateLink RelationLink

A RelationLink that can be used as a template for URIs.

Instances

ToJSON ResourceLink

Defined in Servant.Hateoas.Resource

Methods

toJSON :: ResourceLink -> Value

toEncoding :: ResourceLink -> Encoding

toJSONList :: [ResourceLink] -> Value

toEncodingList :: [ResourceLink] -> Encoding

omitField :: ResourceLink -> Bool

Show ResourceLink

Defined in Servant.Hateoas.Resource

Methods

showsPrec :: Int -> ResourceLink -> ShowS

show :: ResourceLink -> String

showList :: [ResourceLink] -> ShowS

Resource

MkResource

type family MkResource ct :: Type -> Type

Type family computing the Resource-Type belonging to this Content-Type.

Instances

type MkResource (HAL t)

Defined in Servant.Hateoas.ContentType.HAL

type MkResource (HAL t) = HALResource

Base Class

class Resource res where

Class for resources that carry Hypermedia-Relations.

Methods

wrap :: a -> res a

Wrap a value into a Resource.

addRel :: (String, ResourceLink) -> res a -> res a

Add a hypermedia relation (rel, link) to a Resource.

Instances

Resource HALResource

Defined in Servant.Hateoas.ContentType.HAL

Methods

wrap :: a -> HALResource a

addRel :: (String, ResourceLink) -> HALResource a -> HALResource a

addSelfRel :: Resource res => ResourceLink -> res a -> res a

Add the self-relation to a Resource.

Specialized classes

class Resource res => EmbeddingResource res where

Class for Resources that can embed other resources.

Methods

embed :: ToJSON e => (String, res e) -> res a -> res a

Embed a resource b with its relation rel as tuple (rel, b).

Instances

EmbeddingResource HALResource

Defined in Servant.Hateoas.ContentType.HAL

Methods

embed :: ToJSON e => (String, HALResource e) -> HALResource a -> HALResource a

class Resource res => CollectingResource res where

Class for Resources that can collect multiple resources.

Methods

collect :: a -> res a -> res a

Collect a resource into the collection.

Creation

class ToResource res a where

Class for converting values of a to their respective Resource-Representation.

The default implementation wraps the value into a Resource without adding any further information. Therefore you can derive an instance for this class.

Minimal complete definition

Nothing

Methods

toResource :: Proxy res -> a -> res a

Describes how a value a can be converted to a Resource.

default toResource :: Resource res => Proxy res -> a -> res a

Instances

Resource res => ToResource res Intermediate

Defined in Servant.Hateoas.Layer.Type

Methods

toResource :: Proxy res -> Intermediate -> res Intermediate

Resource res => ToResource res [a]

Defined in Servant.Hateoas.Resource

Methods

toResource :: Proxy res -> [a] -> res [a]