Servant.Hateoas.ContentType.Collection

Documentation

data Collection (t :: Type)

Data-Kind representing Content-Types of HATEOAS collections.

Type parameter t is the Mime-Type suffix in application/vnd.collection+t.

Instances

Accept (Collection JSON)

Defined in Servant.Hateoas.ContentType.Collection

Methods

contentType :: Proxy (Collection JSON) -> MediaType

contentTypes :: Proxy (Collection JSON) -> NonEmpty MediaType

ToJSON a => MimeRender (Collection JSON) (CollectionResource a)

Defined in Servant.Hateoas.ContentType.Collection

Methods

mimeRender :: Proxy (Collection JSON) -> CollectionResource a -> ByteString

data CollectionResource a

Resource wrapper for Collection.

Constructors

CollectionResource

Fields

• href :: Maybe Link

  Link to the collection

• items :: [CollectionItem a]

  All items in the collection

• links :: [(String, Link)]

  Pairs (rel, link) for relations

Instances

CollectingResource CollectionResource

Defined in Servant.Hateoas.ContentType.Collection

Methods

collect :: a -> CollectionResource a -> CollectionResource a

Resource CollectionResource

Defined in Servant.Hateoas.ContentType.Collection

Methods

addLink :: forall (a :: k). (String, Link) -> CollectionResource a -> CollectionResource a

(Related a, HasField (IdSelName a) a id, IsElem (GetOneApi a) api, HasLink (GetOneApi a), MkLink (GetOneApi a) Link ~ (id -> Link), BuildRels api (Relations a) a, Resource CollectionResource) => ToCollection (api :: Type) CollectionResource a

Defined in Servant.Hateoas.ContentType.Collection

Methods

toCollection :: Foldable f => f a -> CollectionResource a

toCollection' :: Foldable f => Proxy api -> Proxy CollectionResource -> f a -> CollectionResource a

ToJSON a => MimeRender (Collection JSON) (CollectionResource a)

Defined in Servant.Hateoas.ContentType.Collection

Methods

mimeRender :: Proxy (Collection JSON) -> CollectionResource a -> ByteString

ToJSON a => ToJSON (CollectionResource a)

Defined in Servant.Hateoas.ContentType.Collection

Methods

toJSON :: CollectionResource a -> Value

toEncoding :: CollectionResource a -> Encoding

toJSONList :: [CollectionResource a] -> Value

toEncodingList :: [CollectionResource a] -> Encoding

omitField :: CollectionResource a -> Bool

Generic (CollectionResource a)

Defined in Servant.Hateoas.ContentType.Collection

Associated Types

type Rep (CollectionResource a) :: Type -> Type

Methods

from :: CollectionResource a -> Rep (CollectionResource a) x

to :: Rep (CollectionResource a) x -> CollectionResource a

Show a => Show (CollectionResource a)

Defined in Servant.Hateoas.ContentType.Collection

Methods

showsPrec :: Int -> CollectionResource a -> ShowS

show :: CollectionResource a -> String

showList :: [CollectionResource a] -> ShowS

type Rep (CollectionResource a)

Defined in Servant.Hateoas.ContentType.Collection

type Rep (CollectionResource a) = D1 ('MetaData "CollectionResource" "Servant.Hateoas.ContentType.Collection" "servant-hateoas-0.2.1-inplace" 'False) (C1 ('MetaCons "CollectionResource" 'PrefixI 'True) (S1 ('MetaSel ('Just "href") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Link)) :*: (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [CollectionItem a]) :*: S1 ('MetaSel ('Just "links") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(String, Link)]))))

data CollectionItem a

A single item inside a CollectionResource.

Constructors

CollectionItem

Fields

• item :: a

  Wrapped item

• itemLinks :: [(String, Link)]

  Links for the wrapped item

Instances

Resource CollectionItem

Defined in Servant.Hateoas.ContentType.Collection

Methods

addLink :: forall (a :: k). (String, Link) -> CollectionItem a -> CollectionItem a

ToJSON a => ToJSON (CollectionItem a)

Defined in Servant.Hateoas.ContentType.Collection

Methods

toJSON :: CollectionItem a -> Value

toEncoding :: CollectionItem a -> Encoding

toJSONList :: [CollectionItem a] -> Value

toEncodingList :: [CollectionItem a] -> Encoding

omitField :: CollectionItem a -> Bool

Generic (CollectionItem a)

Defined in Servant.Hateoas.ContentType.Collection

Associated Types

type Rep (CollectionItem a) :: Type -> Type

Methods

from :: CollectionItem a -> Rep (CollectionItem a) x

to :: Rep (CollectionItem a) x -> CollectionItem a

Show a => Show (CollectionItem a)

Defined in Servant.Hateoas.ContentType.Collection

Methods

showsPrec :: Int -> CollectionItem a -> ShowS

show :: CollectionItem a -> String

showList :: [CollectionItem a] -> ShowS

type Rep (CollectionItem a)

Defined in Servant.Hateoas.ContentType.Collection

type Rep (CollectionItem a) = D1 ('MetaData "CollectionItem" "Servant.Hateoas.ContentType.Collection" "servant-hateoas-0.2.1-inplace" 'False) (C1 ('MetaCons "CollectionItem" 'PrefixI 'True) (S1 ('MetaSel ('Just "item") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a) :*: S1 ('MetaSel ('Just "itemLinks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(String, Link)])))