Copyright	(c) Frederick Pringle 2024
License	BSD-3-Clause
Maintainer	freddyjepringle@gmail.com
Safe Haskell	Safe-Inferred
Language	Haskell2010

Servant.API.Routes.Path

Description

Simple representation of URL paths.

Synopsis

data Path
prependPathPart :: Text -> Path -> Path
renderPath :: Path -> Text
rootPath :: Path

Documentation

data Path Source #

Simple representation of a URL path. The constructor and fields are not exported since I may change the internal implementation in the future to use Text instead of [Text].

Instances

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 #

prependPathPart :: Text -> Path -> Path Source #

Equivalent to (:).

renderPath :: Path -> Text Source #

Pretty-print a path, including the leading /.

rootPath :: Path Source #

"/"