Safe Haskell	None
Language	Haskell2010

Dormouse.Url.Builder

Description

Provides syntax for incrementally building Urls and components of Urls such as Query strings

Synopsis

data QueryComponent
- = QueryParam Text Text
- | QueryFlag Text
newtype QueryBuilder = QueryBuilder {
- unQueryBuilder :: Seq QueryComponent
}
class IsQueryVal a where
- toQueryVal :: a -> Text
(</>) :: Url scheme -> Text -> Url scheme
(?) :: Url scheme -> QueryBuilder -> Url scheme
(&) :: QueryBuilder -> QueryBuilder -> QueryBuilder
(=:) :: IsQueryVal a => Text -> a -> QueryBuilder

Documentation

data QueryComponent Source #

An individual Query Parameter or Query Flag

Constructors

QueryParam Text Text
QueryFlag Text

Instances

Instances details

Eq QueryComponent Source #
Instance details Defined in Dormouse.Url.Builder Methods (==) :: QueryComponent -> QueryComponent -> Bool # (/=) :: QueryComponent -> QueryComponent -> Bool #
Show QueryComponent Source #
Instance details Defined in Dormouse.Url.Builder Methods showsPrec :: Int -> QueryComponent -> ShowS # show :: QueryComponent -> String # showList :: [QueryComponent] -> ShowS #

newtype QueryBuilder Source #

Stores a series of Query Parameters or Query Flags used for building the Query component of a URI/URL, for example in the format ?param1=2&param2=3&flag1

Constructors

QueryBuilder
Fields unQueryBuilder :: Seq QueryComponent

Instances

Instances details

Eq QueryBuilder Source #
Instance details Defined in Dormouse.Url.Builder Methods (==) :: QueryBuilder -> QueryBuilder -> Bool # (/=) :: QueryBuilder -> QueryBuilder -> Bool #
Show QueryBuilder Source #
Instance details Defined in Dormouse.Url.Builder Methods showsPrec :: Int -> QueryBuilder -> ShowS # show :: QueryBuilder -> String # showList :: [QueryBuilder] -> ShowS #
Semigroup QueryBuilder Source #
Instance details Defined in Dormouse.Url.Builder Methods (<>) :: QueryBuilder -> QueryBuilder -> QueryBuilder # sconcat :: NonEmpty QueryBuilder -> QueryBuilder # stimes :: Integral b => b -> QueryBuilder -> QueryBuilder #
Monoid QueryBuilder Source #
Instance details Defined in Dormouse.Url.Builder Methods mempty :: QueryBuilder # mappend :: QueryBuilder -> QueryBuilder -> QueryBuilder # mconcat :: [QueryBuilder] -> QueryBuilder #

class IsQueryVal a where Source #

Signifies a type that can be rendered as Query Parameter within a URI

Methods

toQueryVal :: a -> Text Source #

Instances

Instances details

IsQueryVal Bool Source #
Instance details Defined in Dormouse.Url.Builder Methods toQueryVal :: Bool -> Text Source #
IsQueryVal Char Source #
Instance details Defined in Dormouse.Url.Builder Methods toQueryVal :: Char -> Text Source #
IsQueryVal Double Source #
Instance details Defined in Dormouse.Url.Builder Methods toQueryVal :: Double -> Text Source #
IsQueryVal Float Source #
Instance details Defined in Dormouse.Url.Builder Methods toQueryVal :: Float -> Text Source #
IsQueryVal Int Source #
Instance details Defined in Dormouse.Url.Builder Methods toQueryVal :: Int -> Text Source #
IsQueryVal Integer Source #
Instance details Defined in Dormouse.Url.Builder Methods toQueryVal :: Integer -> Text Source #
IsQueryVal Text Source #
Instance details Defined in Dormouse.Url.Builder Methods toQueryVal :: Text -> Text Source #
IsQueryVal String Source #
Instance details Defined in Dormouse.Url.Builder Methods toQueryVal :: String -> Text Source #

(</>) :: Url scheme -> Text -> Url scheme Source #

Combine a Url with a new text path component

(?) :: Url scheme -> QueryBuilder -> Url scheme infixl 8 Source #

Combine a Url with a some supplied query parameters

(&) :: QueryBuilder -> QueryBuilder -> QueryBuilder Source #

Convenient alias for <> which allows for combining query parameters

(=:) :: IsQueryVal a => Text -> a -> QueryBuilder Source #

Generate a query paramter of the form key=value