Path.Extended

Types

data Location b t

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

Constructors

Location

Fields

• locParentJumps :: Int

  only when b ~ Rel

• locPath :: Path b t
• locFileExt :: Maybe String

  only when t ~ File

• locQueryParams :: [QueryParam]
• locFragment :: Maybe String

Instances

PathAppend Location Abs File

Methods

(</>) :: Path Abs Dir -> Location Rel File -> Location Abs File

PathAppend Location Abs Dir

Methods

(</>) :: Path Abs Dir -> Location Rel Dir -> Location Abs Dir

PathAppend Location Rel File

Methods

(</>) :: Path Rel Dir -> Location Rel File -> Location Rel File

PathAppend Location Rel Dir

Methods

(</>) :: Path Rel Dir -> Location Rel Dir -> Location Rel Dir

Eq (Location b t)

Methods

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

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

Ord (Location b t)

Methods

compare :: Location b t -> Location b t -> Ordering

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

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

(>) :: Location b t -> Location b t -> Bool

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

max :: Location b t -> Location b t -> Location b t

min :: Location b t -> Location b t -> Location b t

Show (Location b t)

Methods

showsPrec :: Int -> Location b t -> ShowS

show :: Location b t -> String

showList :: [Location b t] -> ShowS

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

toLocation

Methods

toLocation :: sym -> Location base type'

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

Minimal complete definition

parsePath

Methods

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

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

Minimal complete definition

parseLocation

Methods

parseLocation :: Location base type' -> Either String sym

Combinators

Append

class PathAppend right base type' where

Minimal complete definition

(</>)

Methods

(</>) :: Path base Dir -> right Rel type' -> right base type'

Instances

PathAppend Path Abs File

Methods

(</>) :: Path Abs Dir -> Path Rel File -> Path Abs File

PathAppend Path Abs Dir

Methods

(</>) :: Path Abs Dir -> Path Rel Dir -> Path Abs Dir

PathAppend Path Rel File

Methods

(</>) :: Path Rel Dir -> Path Rel File -> Path Rel File

PathAppend Path Rel Dir

Methods

(</>) :: Path Rel Dir -> Path Rel Dir -> Path Rel Dir

PathAppend Location Abs File

Methods

(</>) :: Path Abs Dir -> Location Rel File -> Location Abs File

PathAppend Location Abs Dir

Methods

(</>) :: Path Abs Dir -> Location Rel Dir -> Location Abs Dir

PathAppend Location Rel File

Methods

(</>) :: Path Rel Dir -> Location Rel File -> Location Rel File

PathAppend Location Rel Dir

Methods

(</>) :: Path Rel Dir -> Location Rel Dir -> Location Rel Dir

Parent Accessors

addParent :: Location Rel t -> Location Rel t

Prepend a parental accessor path - ../

delParent :: Location Rel t -> Location Rel t

Path

fromPath :: Path b t -> Location b t

This should be your entry point for creating a Location.

File Extensions

setFileExt :: Maybe String -> Location b File -> Location b File

addFileExt :: String -> Location b File -> Location b File

delFileExt :: Location b File -> Location b File

getFileExt :: Location b File -> Maybe String

Query Parameters

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

addQuery :: QueryParam -> Location b t -> Location b t

Appends a query parameter

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

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

delQuery :: Location b t -> Location b t

getQuery :: Location b t -> [QueryParam]

Fragment

setFragment :: Maybe String -> Location b t -> Location b t

addFragment :: String -> Location b t -> Location b t

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

delFragment :: Location b t -> Location b t

getFragment :: Location b t -> Maybe String