path-extra-0.3.1: URLs without host information

Safe Haskell	None
Language	Haskell2010

Path.Extended

Contents

Types
Classes
Combinators

Synopsis

data Location base = Location {
- locPath :: LocationPath base
- locQueryParams :: [QueryParam]
- locFragment :: Maybe String
}
data LocationPath base
- = Dir (Path base Dir)
- | File (Path base File)
type QueryParam = (String, Maybe String)
class ToPath sym base type' | sym -> base type' where
- toPath :: sym -> Path base type'
class ToLocation sym base | sym -> base where
- toLocation :: sym -> Location base
class FromPath sym base type' | sym -> base type' where
- parsePath :: Path base type' -> Either String sym
class FromLocation sym base | sym -> base where
- parseLocation :: Location base -> Either String sym
fromDir :: Path base Dir -> Location base
fromFile :: Path base File -> Location base
prependAbs :: Path Abs Dir -> Location Abs -> Location Abs
prependRel :: Path Rel Dir -> Location Rel -> Location Rel
setQuery :: [QueryParam] -> Location base -> Location base
addQuery :: QueryParam -> Location base -> Location base
(<&>) :: Location base -> QueryParam -> Location base
addQueries :: [QueryParam] -> Location base -> Location base
delQuery :: Location base -> Location base
getQuery :: Location base -> [QueryParam]
setFragment :: Maybe String -> Location base -> Location base
addFragment :: String -> Location base -> Location base
(<#>) :: Location base -> String -> Location base
delFragment :: Location base -> Location base
getFragment :: Location base -> Maybe String
locationAbsParser :: Parser (Location Abs)
locationRelParser :: Parser (Location Rel)
printLocation :: Location base -> Text

Types

data Location base Source #

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

Constructors

Location
Fields locPath :: LocationPath base locQueryParams :: [QueryParam] locFragment :: Maybe String

Instances

Instances details

Generic (Location base) Source #

Instance details

Defined in Path.Extended

Associated Types

type Rep (Location base)

Instance details

Defined in Path.Extended

type Rep (Location base) = D1 ('MetaData "Location" "Path.Extended" "path-extra-0.3.1-RKmSUl80a2IqJ0lgx66bV" 'False) (C1 ('MetaCons "Location" 'PrefixI 'True) (S1 ('MetaSel ('Just "locPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (LocationPath base)) :*: (S1 ('MetaSel ('Just "locQueryParams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [QueryParam]) :*: S1 ('MetaSel ('Just "locFragment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe String)))))

Methods

from :: Location base -> Rep (Location base) x #

to :: Rep (Location base) x -> Location base #

Show (Location base) Source #

Instance details

Defined in Path.Extended

Methods

showsPrec :: Int -> Location base -> ShowS #

show :: Location base -> String #

showList :: [Location base] -> ShowS #

Eq (Location base) Source #

Instance details

Defined in Path.Extended

Methods

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

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

Ord (Location base) Source #

Instance details

Defined in Path.Extended

Methods

compare :: Location base -> Location base -> Ordering #

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

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

(>) :: Location base -> Location base -> Bool #

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

max :: Location base -> Location base -> Location base #

min :: Location base -> Location base -> Location base #

type Rep (Location base) Source #

Instance details

Defined in Path.Extended

type Rep (Location base) = D1 ('MetaData "Location" "Path.Extended" "path-extra-0.3.1-RKmSUl80a2IqJ0lgx66bV" 'False) (C1 ('MetaCons "Location" 'PrefixI 'True) (S1 ('MetaSel ('Just "locPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (LocationPath base)) :*: (S1 ('MetaSel ('Just "locQueryParams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [QueryParam]) :*: S1 ('MetaSel ('Just "locFragment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe String)))))

data LocationPath base Source #

Constructors

Dir (Path base Dir)
File (Path base File)

Instances

Instances details

Generic (LocationPath base) Source #

Instance details

Defined in Path.Extended

Associated Types

type Rep (LocationPath base)

Instance details

Defined in Path.Extended

type Rep (LocationPath base) = D1 ('MetaData "LocationPath" "Path.Extended" "path-extra-0.3.1-RKmSUl80a2IqJ0lgx66bV" 'False) (C1 ('MetaCons "Dir" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Path base Dir))) :+: C1 ('MetaCons "File" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Path base File))))

Methods

from :: LocationPath base -> Rep (LocationPath base) x #

to :: Rep (LocationPath base) x -> LocationPath base #

Show (LocationPath base) Source #

Instance details

Defined in Path.Extended

Methods

showsPrec :: Int -> LocationPath base -> ShowS #

show :: LocationPath base -> String #

showList :: [LocationPath base] -> ShowS #

Eq (LocationPath base) Source #

Instance details

Defined in Path.Extended

Methods

(==) :: LocationPath base -> LocationPath base -> Bool #

(/=) :: LocationPath base -> LocationPath base -> Bool #

Ord (LocationPath base) Source #

Instance details

Defined in Path.Extended

Methods

compare :: LocationPath base -> LocationPath base -> Ordering #

(<) :: LocationPath base -> LocationPath base -> Bool #

(<=) :: LocationPath base -> LocationPath base -> Bool #

(>) :: LocationPath base -> LocationPath base -> Bool #

(>=) :: LocationPath base -> LocationPath base -> Bool #

max :: LocationPath base -> LocationPath base -> LocationPath base #

min :: LocationPath base -> LocationPath base -> LocationPath base #

type Rep (LocationPath base) Source #

Instance details

Defined in Path.Extended

type Rep (LocationPath base) = D1 ('MetaData "LocationPath" "Path.Extended" "path-extra-0.3.1-RKmSUl80a2IqJ0lgx66bV" 'False) (C1 ('MetaCons "Dir" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Path base Dir))) :+: C1 ('MetaCons "File" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Path base File))))

type QueryParam = (String, Maybe String) Source #

Classes

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

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

Methods

toPath :: sym -> Path base type' Source #

class ToLocation sym base | sym -> base where Source #

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

Methods

toLocation :: sym -> Location base Source #

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

Methods

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

class FromLocation sym base | sym -> base where Source #

Methods

parseLocation :: Location base -> Either String sym Source #

Combinators

Path

fromDir :: Path base Dir -> Location base Source #

fromFile :: Path base File -> Location base Source #

prependAbs :: Path Abs Dir -> Location Abs -> Location Abs Source #

prependRel :: Path Rel Dir -> Location Rel -> Location Rel Source #

Query Parameters

setQuery :: [QueryParam] -> Location base -> Location base Source #

addQuery :: QueryParam -> Location base -> Location base Source #

Appends a query parameter

(<&>) :: Location base -> QueryParam -> Location base infixl 7 Source #

addQueries :: [QueryParam] -> Location base -> Location base Source #

delQuery :: Location base -> Location base Source #

getQuery :: Location base -> [QueryParam] Source #

Fragment

setFragment :: Maybe String -> Location base -> Location base Source #

addFragment :: String -> Location base -> Location base Source #

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

delFragment :: Location base -> Location base Source #

getFragment :: Location base -> Maybe String Source #

Parser & Printer

locationAbsParser :: Parser (Location Abs) Source #

locationRelParser :: Parser (Location Rel) Source #

printLocation :: Location base -> Text Source #