Servant.Hateoas.RelationLink

RelationLink

Type

data RelationLink

Link data-type for hypermedia-links in HATEOAS with potentially templated URIs.

Constructors

RelationLink

Fields

• _segs :: [Text]
• _params :: [RelationParam]
• _fragment :: Maybe Text
• _templated :: Bool
• _method :: StdMethod
• _contentTypes :: [MediaType]
• _summary :: Maybe Text
• _description :: Maybe Text
• _title :: Maybe Text

Instances

ToJSON RelationLink

Defined in Servant.Hateoas.RelationLink

Methods

toJSON :: RelationLink -> Value

toEncoding :: RelationLink -> Encoding

toJSONList :: [RelationLink] -> Value

toEncodingList :: [RelationLink] -> Encoding

omitField :: RelationLink -> Bool

Show RelationLink

Defined in Servant.Hateoas.RelationLink

Methods

showsPrec :: Int -> RelationLink -> ShowS

show :: RelationLink -> String

showList :: [RelationLink] -> ShowS

Eq RelationLink

Defined in Servant.Hateoas.RelationLink

Methods

(==) :: RelationLink -> RelationLink -> Bool

(/=) :: RelationLink -> RelationLink -> Bool

data RelationParam

Parameter data-type for hypermedia-links in HATEOAS.

Constructors

RelationParam

Fields

• _name :: Text
• _required :: Bool
• _value :: Maybe Text

Instances

Show RelationParam

Defined in Servant.Hateoas.RelationLink

Methods

showsPrec :: Int -> RelationParam -> ShowS

show :: RelationParam -> String

showList :: [RelationParam] -> ShowS

Eq RelationParam

Defined in Servant.Hateoas.RelationLink

Methods

(==) :: RelationParam -> RelationParam -> Bool

(/=) :: RelationParam -> RelationParam -> Bool

Creation

fromLink :: [MediaType] -> StdMethod -> Link -> RelationLink

Creates a RelationLink from a Link.

fromURI :: [MediaType] -> StdMethod -> URI -> RelationLink

Creates a RelationLink from an URI.

Operations

(<<<) :: RelationLink -> RelationLink -> RelationLink

Shifting append-operator for RelationLink.

This operator can be seen as a monoidal append for RelationLink with a right-bias for meta information e.g. _method, _contentTypes, _summary and _description.

getHref :: RelationLink -> Text

Get the hypermedia-reference of a RelationLink.

getPath :: RelationLink -> Text

Get the path of a RelationLink as in getHref.

getParams :: RelationLink -> Text

Get the parameters of a RelationLink as in getHref.

prependSeg :: Text -> RelationLink -> RelationLink

Prepend a path segment to a RelationLink.

Takes care of potential templating.

prependSegs :: [Text] -> RelationLink -> RelationLink

Prepend path segments to a RelationLink.

Takes care of potential templating.

addParam :: RelationParam -> RelationLink -> RelationLink

Add a parameter to a RelationLink.

Takes care of potential templating.

addParams :: [RelationParam] -> RelationLink -> RelationLink

Add parameters to a RelationLink.

Takes care of potential templating.

mkPlaceHolder :: Text -> Text

Create a placeholder for a template path segment.

Class

class HasTemplatedLink endpoint where

Class for creating a templated RelationLink to an endpoint.

Methods

toTemplatedLink :: Proxy endpoint -> RelationLink

Instances

ReflectMethod m => HasTemplatedLink (NoContentVerb m :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toTemplatedLink :: Proxy (NoContentVerb m) -> RelationLink

(KnownSymbol sym, HasTemplatedLink b) => HasTemplatedLink (sym :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toTemplatedLink :: Proxy (sym :> b) -> RelationLink

HasTemplatedLink b => HasTemplatedLink (HttpVersion :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toTemplatedLink :: Proxy (HttpVersion :> b) -> RelationLink

HasTemplatedLink b => HasTemplatedLink (BasicAuth realm userData :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toTemplatedLink :: Proxy (BasicAuth realm userData :> b) -> RelationLink

(KnownSymbol sym, HasTemplatedLink b) => HasTemplatedLink (Capture' mods sym a :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toTemplatedLink :: Proxy (Capture' mods sym a :> b) -> RelationLink

(KnownSymbol sym, HasTemplatedLink b) => HasTemplatedLink (CaptureAll sym a :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toTemplatedLink :: Proxy (CaptureAll sym a :> b) -> RelationLink

(KnownSymbol sym, HasTemplatedLink b) => HasTemplatedLink (Description sym :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toTemplatedLink :: Proxy (Description sym :> b) -> RelationLink

(KnownSymbol sym, HasTemplatedLink b) => HasTemplatedLink (Summary sym :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toTemplatedLink :: Proxy (Summary sym :> b) -> RelationLink

HasTemplatedLink b => HasTemplatedLink (EmptyAPI :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toTemplatedLink :: Proxy (EmptyAPI :> b) -> RelationLink

HasTemplatedLink b => HasTemplatedLink (Fragment a :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toTemplatedLink :: Proxy (Fragment a :> b) -> RelationLink

HasTemplatedLink b => HasTemplatedLink (Header' mods sym a :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toTemplatedLink :: Proxy (Header' mods sym a :> b) -> RelationLink

HasTemplatedLink b => HasTemplatedLink (IsSecure :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toTemplatedLink :: Proxy (IsSecure :> b) -> RelationLink

(HasTemplatedLink b, KnownSymbol sym) => HasTemplatedLink (QueryFlag sym :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toTemplatedLink :: Proxy (QueryFlag sym :> b) -> RelationLink

(HasTemplatedLink b, KnownSymbol sym, SBoolI (FoldRequired mods)) => HasTemplatedLink (QueryParam' mods sym a :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toTemplatedLink :: Proxy (QueryParam' mods sym a :> b) -> RelationLink

(HasTemplatedLink b, KnownSymbol sym) => HasTemplatedLink (QueryParams sym a :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toTemplatedLink :: Proxy (QueryParams sym a :> b) -> RelationLink

(HasTemplatedLink b, KnownSymbol sym) => HasTemplatedLink (DeepQuery sym a :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toTemplatedLink :: Proxy (DeepQuery sym a :> b) -> RelationLink

HasTemplatedLink b => HasTemplatedLink (QueryString :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toTemplatedLink :: Proxy (QueryString :> b) -> RelationLink

HasTemplatedLink b => HasTemplatedLink (RemoteHost :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toTemplatedLink :: Proxy (RemoteHost :> b) -> RelationLink

HasTemplatedLink b => HasTemplatedLink (ReqBody' mods cts a :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toTemplatedLink :: Proxy (ReqBody' mods cts a :> b) -> RelationLink

HasTemplatedLink b => HasTemplatedLink (WithNamedContext name subs sub :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toTemplatedLink :: Proxy (WithNamedContext name subs sub :> b) -> RelationLink

HasTemplatedLink b => HasTemplatedLink (WithResource res :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toTemplatedLink :: Proxy (WithResource res :> b) -> RelationLink

(KnownSymbol title, HasTemplatedLink api) => HasTemplatedLink (Title title :> api :: Type)

Defined in Servant.Hateoas.Combinator.Title

Methods

toTemplatedLink :: Proxy (Title title :> api) -> RelationLink

(HasTemplatedLink api, KnownSymbol sym) => HasTemplatedLink (Sym sym :> api :: Type)

Defined in Servant.Hateoas.Internal.Sym

Methods

toTemplatedLink :: Proxy (Sym sym :> api) -> RelationLink

HasTemplatedLink b => HasTemplatedLink (Vault :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toTemplatedLink :: Proxy (Vault :> b) -> RelationLink

(ReflectMethod m, AllMime cts) => HasTemplatedLink (UVerb m cts as :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toTemplatedLink :: Proxy (UVerb m cts as) -> RelationLink

(ReflectMethod m, AllMime cts) => HasTemplatedLink (Verb m s cts a :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toTemplatedLink :: Proxy (Verb m s cts a) -> RelationLink

(ReflectMethod m, Accept ct) => HasTemplatedLink (Stream m s f ct a :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toTemplatedLink :: Proxy (Stream m s f ct a) -> RelationLink

class HasLink endpoint => HasRelationLink endpoint where

Class for creating a RelationLink to an endpoint.

This is highly similar to HasLink but it also gathers HATEOAS meta-information for the resource a link refers to.

Methods

toRelationLink :: Proxy endpoint -> MkLink endpoint RelationLink

Instances

ReflectMethod m => HasRelationLink (NoContentVerb m :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (NoContentVerb m) -> MkLink (NoContentVerb m) RelationLink

(KnownSymbol sym, RightLink b) => HasRelationLink (sym :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (sym :> b) -> MkLink (sym :> b) RelationLink

HasRelationLink b => HasRelationLink (HttpVersion :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (HttpVersion :> b) -> MkLink (HttpVersion :> b) RelationLink

HasRelationLink b => HasRelationLink (BasicAuth realm userData :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (BasicAuth realm userData :> b) -> MkLink (BasicAuth realm userData :> b) RelationLink

(KnownSymbol sym, RightLink b, ToHttpApiData a) => HasRelationLink (Capture' mods sym a :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (Capture' mods sym a :> b) -> MkLink (Capture' mods sym a :> b) RelationLink

(KnownSymbol sym, RightLink b, ToHttpApiData a) => HasRelationLink (CaptureAll sym a :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (CaptureAll sym a :> b) -> MkLink (CaptureAll sym a :> b) RelationLink

(KnownSymbol sym, RightLink b) => HasRelationLink (Description sym :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (Description sym :> b) -> MkLink (Description sym :> b) RelationLink

(KnownSymbol sym, RightLink b) => HasRelationLink (Summary sym :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (Summary sym :> b) -> MkLink (Summary sym :> b) RelationLink

(RightLink b, ToHttpApiData a) => HasRelationLink (Fragment a :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (Fragment a :> b) -> MkLink (Fragment a :> b) RelationLink

HasRelationLink b => HasRelationLink (Header' mods sym a :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (Header' mods sym a :> b) -> MkLink (Header' mods sym a :> b) RelationLink

HasRelationLink b => HasRelationLink (IsSecure :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (IsSecure :> b) -> MkLink (IsSecure :> b) RelationLink

(KnownSymbol sym, RightLink b) => HasRelationLink (QueryFlag sym :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (QueryFlag sym :> b) -> MkLink (QueryFlag sym :> b) RelationLink

(KnownSymbol sym, ToHttpApiData a, RightLink b, SBoolI (FoldRequired mods)) => HasRelationLink (QueryParam' mods sym a :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (QueryParam' mods sym a :> b) -> MkLink (QueryParam' mods sym a :> b) RelationLink

(KnownSymbol sym, RightLink b, ToHttpApiData a) => HasRelationLink (QueryParams sym a :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (QueryParams sym a :> b) -> MkLink (QueryParams sym a :> b) RelationLink

RightLink b => HasRelationLink (RemoteHost :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (RemoteHost :> b) -> MkLink (RemoteHost :> b) RelationLink

RightLink b => HasRelationLink (ReqBody' mods cts a :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (ReqBody' mods cts a :> b) -> MkLink (ReqBody' mods cts a :> b) RelationLink

RightLink b => HasRelationLink (WithResource res :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (WithResource res :> b) -> MkLink (WithResource res :> b) RelationLink

(KnownSymbol title, RightLink api) => HasRelationLink (Title title :> api :: Type)

Defined in Servant.Hateoas.Combinator.Title

Methods

toRelationLink :: Proxy (Title title :> api) -> MkLink (Title title :> api) RelationLink

(KnownSymbol sym, HasRelationLink (sym :> api), HasLink api) => HasRelationLink (Sym sym :> api :: Type)

Defined in Servant.Hateoas.Internal.Sym

Methods

toRelationLink :: Proxy (Sym sym :> api) -> MkLink (Sym sym :> api) RelationLink

RightLink b => HasRelationLink (Vault :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (Vault :> b) -> MkLink (Vault :> b) RelationLink

(AllMime cts, ReflectMethod m) => HasRelationLink (UVerb m cts as :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (UVerb m cts as) -> MkLink (UVerb m cts as) RelationLink

(AllMime cts, ReflectMethod m) => HasRelationLink (Verb m s cts a :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (Verb m s cts a) -> MkLink (Verb m s cts a) RelationLink

(ReflectMethod m, Accept ct) => HasRelationLink (Stream m s f ct a :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (Stream m s f ct a) -> MkLink (Stream m s f ct a) RelationLink

type RightLink b = (HasRelationLink b, PolyvariadicComp (MkLink b RelationLink) (IsFun (MkLink b RelationLink)), Return (MkLink b RelationLink) (IsFun (MkLink b RelationLink)) ~ RelationLink, Replace (MkLink b RelationLink) RelationLink (IsFun (MkLink b RelationLink)) ~ MkLink b RelationLink)

Convenience alias-constraint for right-hand sides of a :> b where b is some function producing a RelationLink.

Utility

ReflectStdMethod

reflectStdMethod :: ReflectMethod method => Proxy method -> StdMethod

Like reflectMethod but returns a StdMethod.