Servant.API.Routes.Path

Description

Simple representation of URL paths.

Synopsis

Documentation

Simple representation of a URL path.

Instances details

ToJSON Path Source #
Instance details Defined in Servant.API.Routes.Internal.Path Methods toJSON :: Path -> Value Source # toEncoding :: Path -> Encoding Source # toJSONList :: [Path] -> Value Source # toEncodingList :: [Path] -> Encoding Source #
Show Path Source #
Instance details Defined in Servant.API.Routes.Internal.Path Methods showsPrec :: Int -> Path -> ShowS Source # show :: Path -> String Source # showList :: [Path] -> ShowS Source #
Eq Path Source #
Instance details Defined in Servant.API.Routes.Internal.Path Methods (==) :: Path -> Path -> Bool Source # (/=) :: Path -> Path -> Bool Source #
Ord Path Source #
Instance details Defined in Servant.API.Routes.Internal.Path Methods compare :: Path -> Path -> Ordering Source # (<) :: Path -> Path -> Bool Source # (<=) :: Path -> Path -> Bool Source # (>) :: Path -> Path -> Bool Source # (>=) :: Path -> Path -> Bool Source # max :: Path -> Path -> Path Source # min :: Path -> Path -> Path Source #

Prepend a simple text path part to an API path.

For example, prependPathPart "api" will transform /v2/users to /api/v2/users.

Prepend a capture path part of a given type to an API path. Equivalent to Capture name a :>.

For example, prependCapturePart @Int "id" will transform /detail to /<Int>/detail.

Prepend a capture-all path part of a given type to an API path. Equivalent to CaptureAll name a :>.

For example, prependCaptureAllPart @Int "id" will transform /detail to /<[Int]>/detail.

Pretty-print a path, including the leading /.

"/"