servant-routes-0.1.0.0: Generate route descriptions from Servant APIs
Copyright(c) Frederick Pringle 2025
LicenseBSD-3-Clause
Maintainerfreddyjepringle@gmail.com
Safe HaskellSafe-Inferred
LanguageHaskell2010

Servant.API.Routes.Internal.Path

Description

Internal module, subject to change.

Synopsis

Documentation

newtype Path Source #

Simple representation of a URL path.

Constructors

Path 

Fields

Instances

Instances details
ToJSON Path Source # 
Instance details

Defined in Servant.API.Routes.Internal.Path

Show Path Source # 
Instance details

Defined in Servant.API.Routes.Internal.Path

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

renderPath :: Path -> Text Source #

Pretty-print a path, including the leading /.

pathSeparator :: Text Source #

Standard path separator "/".

data PathPart Source #

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.