Data.URLEncoded

Implements a data type for constructing and destructing x-www-urlencoded strings. See http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4.1

Representation of a URL-encoded string

data URLEncoded

A container for URLEncoded data

Instances

Eq URLEncoded

Methods

(==) :: URLEncoded -> URLEncoded -> Bool

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

Show URLEncoded

Methods

showsPrec :: Int -> URLEncoded -> ShowS

show :: URLEncoded -> String

showList :: [URLEncoded] -> ShowS

Semigroup URLEncoded

Methods

(<>) :: URLEncoded -> URLEncoded -> URLEncoded

sconcat :: NonEmpty URLEncoded -> URLEncoded

stimes :: Integral b => b -> URLEncoded -> URLEncoded

Monoid URLEncoded

Methods

mempty :: URLEncoded

mappend :: URLEncoded -> URLEncoded -> URLEncoded

mconcat :: [URLEncoded] -> URLEncoded

URLShow URLEncoded

Methods

urlShow :: URLEncoded -> String

URLEncode URLEncoded

Methods

urlEncode :: URLEncoded -> URLEncoded

AddURLEncoded URLEncoded

Methods

(%?) :: URLEncode args => URLEncoded -> args -> URLEncoded

filter :: ((String, String) -> Bool) -> URLEncoded -> URLEncoded

Create a URLEncoded object that represents all pairs from the input that match the supplied predicate

class URLShow a where

Serialize a value into a String for encoding as part of an x-www-urlencoded value

Minimal complete definition

urlShow

Methods

urlShow :: a -> String

Instances

URLShow Bool

Methods

urlShow :: Bool -> String

URLShow Char

Methods

urlShow :: Char -> String

URLShow Int

Methods

urlShow :: Int -> String

URLShow Integer

Methods

urlShow :: Integer -> String

URLShow URI

Methods

urlShow :: URI -> String

URLShow URLEncoded

Methods

urlShow :: URLEncoded -> String

URLShow [Char]

Methods

urlShow :: [Char] -> String

class URLEncode a where

Encode a value as x-www-urlencoded

Minimal complete definition

urlEncode

Methods

urlEncode :: a -> URLEncoded

Instances

URLEncode URLEncoded

Methods

urlEncode :: URLEncoded -> URLEncoded

URLEncode a => URLEncode (Maybe a)

Methods

urlEncode :: Maybe a -> URLEncoded

(URLShow a, URLShow b) => URLEncode (a, b)

Methods

urlEncode :: (a, b) -> URLEncoded

Generate

empty :: URLEncoded

URLEncoded data with no pairs

importString :: MonadError e m => String -> m URLEncoded

Parse this string as x-www-urlencoded

importList :: [(String, String)] -> URLEncoded

Import this list of pairs as URLEncoded data

importURI :: MonadError e m => URI -> m URLEncoded

(%=) :: (URLShow a, URLShow b) => a -> b -> URLEncoded infixl 8

Create singleton URLEncoded data containing the supplied key and value

(%=?) infixl 8

Arguments

:: (URLShow a, URLShow b)

=> a

key

-> Maybe b

value

-> URLEncoded

If the second value is Nothing, return empty URLEncoded data. Otherwise return singleton URLEncoded data that contains the given key and value.

(%&) :: (URLEncode q1, URLEncode q2) => q1 -> q2 -> URLEncoded infixr 7

class AddURLEncoded a where

Minimal complete definition

(%?)

Methods

(%?) :: URLEncode args => a -> args -> a infixr 6

Instances

AddURLEncoded URI

Methods

(%?) :: URLEncode args => URI -> args -> URI

AddURLEncoded URLEncoded

Methods

(%?) :: URLEncode args => URLEncoded -> args -> URLEncoded

AddURLEncoded [Char]

Methods

(%?) :: URLEncode args => [Char] -> args -> [Char]

Query

null :: URLEncoded -> Bool

Is this URLEncoded data empty?

keys :: URLEncoded -> [String]

All of the keys from the URLEncoded value, in order, preserving duplicates

lookup :: URLShow a => a -> URLEncoded -> Maybe String

lookupAll :: URLShow a => a -> URLEncoded -> [String]

Return all values whose keys match the supplied key, in the order they appear in the query. Will return an empty list if no keys match.

lookup1 :: (URLShow a, MonadError e m) => a -> URLEncoded -> m String

Return the first value for the given key, or throw an error if the key is not present in the URLEncoded data.

lookupDefault :: URLShow a => String -> a -> URLEncoded -> String

pairs :: URLEncoded -> [(String, String)]

(%!) :: URLShow a => URLEncoded -> a -> Maybe String infixr 1

Look up a key in a URLEncoded value and return the first matching value, or Nothing if there is no value that matches

Export

addToURI :: URLEncoded -> URI -> URI

Add this URL-encoded data to the query part of a URI, after any existing query arguments.

export :: URLEncoded -> String

Convert this URLEncoded object into an x-www-urlencoded String (The resulting string is 7-bit clean ASCII, containing only unreserved URI characters and %-encoded values)