Path.Extended

Types

data Location

A location for some base and type - internally uses Path.

Constructors

Location

Fields

• locPath :: Either (Path Abs Dir) (Path Abs File)
• locQueryParams :: [QueryParam]
• locFragment :: Maybe String

Instances

Eq Location

Methods

(==) :: Location -> Location -> Bool

(/=) :: Location -> Location -> Bool

Ord Location

Methods

compare :: Location -> Location -> Ordering

(<) :: Location -> Location -> Bool

(<=) :: Location -> Location -> Bool

(>) :: Location -> Location -> Bool

(>=) :: Location -> Location -> Bool

max :: Location -> Location -> Location

min :: Location -> Location -> Location

Generic Location

Associated Types

type Rep Location :: * -> *

Methods

from :: Location -> Rep Location x

to :: Rep Location x -> Location

type Rep Location

type Rep Location = D1 * (MetaData "Location" "Path.Extended" "path-extra-0.2.0-A7d29UYIj7d1tLdwKgjFPG" False) (C1 * (MetaCons "Location" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "locPath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Either (Path Abs Dir) (Path Abs File)))) ((:*:) * (S1 * (MetaSel (Just Symbol "locQueryParams") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [QueryParam])) (S1 * (MetaSel (Just Symbol "locFragment") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe String))))))

type QueryParam = (String, Maybe String)

Classes

class ToPath sym base type' | sym -> base type' where

Convenience typeclass for symbolic, stringless routes - make an instance for your own data type to use your constructors as route-referencing symbols.

Minimal complete definition

toPath

Methods

toPath :: sym -> Path base type'

class ToLocation sym where

Convenience typeclass for symbolic, stringless routes - make an instance for your own data type to use your constructors as route-referencing symbols.

Minimal complete definition

toLocation

Methods

toLocation :: sym -> Location

class FromPath sym base type' | sym -> base type' where

Minimal complete definition

parsePath

Methods

parsePath :: Path base type' -> Either String sym

class FromLocation sym where

Minimal complete definition

parseLocation

Methods

parseLocation :: Location -> Either String sym

Combinators

Path

fromAbsDir :: Path Abs Dir -> Location

fromAbsFile :: Path Abs File -> Location

prepend :: Path Abs Dir -> Location -> Location

Query Parameters

setQuery :: [QueryParam] -> Location -> Location

addQuery :: QueryParam -> Location -> Location

Appends a query parameter

(<&>) :: Location -> QueryParam -> Location infixl 7

addQueries :: [QueryParam] -> Location -> Location

delQuery :: Location -> Location

getQuery :: Location -> [QueryParam]

Fragment

setFragment :: Maybe String -> Location -> Location

addFragment :: String -> Location -> Location

(<#>) :: Location -> String -> Location infixl 8

delFragment :: Location -> Location

getFragment :: Location -> Maybe String

Parser & Printer

locationParser :: Parser Location

printLocation :: Location -> Text