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

Show URLEncoded

Monoid URLEncoded

URLShow URLEncoded

URLEncode URLEncoded

AddURLEncoded 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

Methods

urlShow :: a -> String

Instances

URLShow Bool

URLShow Char

URLShow Int

URLShow Integer

URLShow URI

URLShow URLEncoded

URLShow [Char]

class URLEncode a where

Encode a value as x-www-urlencoded

Methods

urlEncode :: a -> URLEncoded

Instances

URLEncode URLEncoded

URLEncode a => URLEncode (Maybe a)

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

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

Methods

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

Instances

AddURLEncoded URI

AddURLEncoded URLEncoded

AddURLEncoded [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)