Copyright	(c) Frederick Pringle 2025
License	BSD-3-Clause
Maintainer	frederick.pringle@fpringle.com
Safe Haskell	None
Language	Haskell2010

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

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 /.

"/"