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

Servant.API.Routes.Internal.Path

Description

Internal module, subject to change.

Synopsis

Documentation

Simple representation of a URL path.

Constructors

Path
Fields unPath :: [PathPart]

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 #

Pretty-print a path, including the leading /.

Standard path separator "/".

A segment of an API path (between "/"s).

Constructors

StringPart Text	Just a plain path part, e.g. `"api/"`.
CapturePart Text TypeRep	Capture a path part as a variable.
CaptureAllPart Text TypeRep	Capture all path part as a list of variables.

Instances details

IsString PathPart Source #
Instance details Defined in Servant.API.Routes.Internal.Path Methods fromString :: String -> PathPart #
Show PathPart Source #
Instance details Defined in Servant.API.Routes.Internal.Path Methods showsPrec :: Int -> PathPart -> ShowS # show :: PathPart -> String # showList :: [PathPart] -> ShowS #
Eq PathPart Source #
Instance details Defined in Servant.API.Routes.Internal.Path Methods (==) :: PathPart -> PathPart -> Bool # (/=) :: PathPart -> PathPart -> Bool #
Ord PathPart Source #
Instance details Defined in Servant.API.Routes.Internal.Path Methods compare :: PathPart -> PathPart -> Ordering # (<) :: PathPart -> PathPart -> Bool # (<=) :: PathPart -> PathPart -> Bool # (>) :: PathPart -> PathPart -> Bool # (>=) :: PathPart -> PathPart -> Bool # max :: PathPart -> PathPart -> PathPart # min :: PathPart -> PathPart -> PathPart #