Network.Protocol.Uri

See rfc2396 for more info.

URI datatype.

type Scheme = String

type RegName = String

type Port = Int

type Query = String

type Fragment = String

type Hash = String

type UserInfo = String

type PathSegment = String

type Parameters = [(String, Maybe String)]

data Domain

Constructors

Domain [String]

Instances

Eq Domain

Ord Domain

Show Domain

data IPv4

Constructors

IPv4 Int Int Int Int

Instances

Eq IPv4

Ord IPv4

Show IPv4

data Path

Constructors

Path [PathSegment]

Instances

Eq Path

Ord Path

Show Path

data Host

Constructors

Hostname Domain

RegName RegName

IP IPv4

Instances

Eq Host

Ord Host

Show Host

data Authority

Constructors

Authority UserInfo Host (Maybe Port)

Instances

Eq Authority

Ord Authority

Show Authority

data Uri

Constructors

Uri Bool Scheme Authority Path Query Fragment

Instances

Eq Uri

Ord Uri

Show Uri

Accessing parts of URIs.

relative :: Uri :-> Bool

Is a URI relative?

scheme :: Uri :-> Scheme

Access the scheme part of the URI. A scheme is probably the protocol indicator like http, ftp, etc.

userinfo :: Uri :-> String

Access the userinfo part of the URI. The userinfo contains an optional username and password or some other credentials.

authority :: Uri :-> Authority

Access authority part of the URI.

host :: Uri :-> String

Access the host part of the URI.

domain :: Uri :-> Maybe Domain

Access domain part of the URI, returns Nothing when the host is a regname or IP-address.

ipv4 :: Uri :-> Maybe IPv4

Access IPv4-address part of the URI, returns Nothing when the host is a domain or regname.

regname :: Uri :-> Maybe RegName

Access regname part of the URI, returns Nothing when the host is a domain or IP-address.

port :: Uri :-> Maybe Port

Access the port number part of the URI when available.

path :: Uri :-> FilePath

Access the path part of the URI. The query will be properly decoded when reading and encoded when writing.

segments :: Uri :-> [PathSegment]

Access the path part of the URI as a list of path segments. The segments will still be URI-encoded.

query :: Uri :-> Query

Access the query part of the URI, the part that follows the ?. The query will be properly decoded when reading and encoded when writing.

fragment :: Uri :-> Fragment

Access the fragment part of the URI, the part that follows the #. The fragment will be properly decoded when reading and encoded when writing.

More advanced labels and functions.

pathAndQuery :: Uri :-> String

Access the path and query parts of the URI as a single string. The string will will be properly decoded when reading and encoded when writing.

queryParams :: Uri :-> Parameters

Fetch the query parameters form a URI.

params :: String :<->: Parameters

Generic lens to parse/print a string as query parameters.

extension :: FilePath :-> Maybe String

Label to access the extension of a filename.

remap :: (Uri, Uri) -> Uri -> Maybe Uri

Map one URI to another using a URI mapping scheme. A URI mapping scheme is simply a pair of URIs of which only the host part, port number and path will be taken into account when mapping.

Encoding/decoding URI encoded strings.

encode :: String -> String

URI encode a string.

decode :: String -> String

URI decode a string.

encoded :: String :<->: String

Decoding and encoding as a label.

Creating empty URIs.

mkUri :: Uri

Constructors for making empty URI.

mkScheme :: Scheme

Constructors for making empty Scheme.

mkPath :: Path

Constructors for making empty Path.

mkAuthority :: Authority

Constructors for making empty Authority.

mkQuery :: Query

Constructors for making empty Query.

mkFragment :: Fragment

Constructors for making empty Fragment.

mkUserinfo :: UserInfo

Constructors for making empty UserInfo.

mkHost :: Host

Constructors for making empty Host.

mkPort :: Maybe Port

Constructors for making empty Port.

Parsing URIs.

toUri :: String -> Uri

Parse string into a URI and ignore all failures by returning an empty URI when parsing fails. Can be quite useful in situations that parse errors are unlikely.

parseUri :: String -> Either ParseError Uri

Parse string into a URI.

parseAbsoluteUri :: String -> Either ParseError Uri

Parse string into a URI and only accept absolute URIs.

parseAuthority :: String -> Either ParseError Authority

Parse string into an authority.

parsePath :: String -> Either ParseError Path

Parse string into a path.

parseHost :: String -> Either ParseError Host

Parse string into a host.

Filename related utilities.

mimetype :: FilePath -> Maybe String

Try to guess the correct mime type for the input file based on the file extension.

normalize :: FilePath -> FilePath

Normalize a path by removing or merging all dot or dot-dot segments and double slashes.

jail

Arguments

:: FilePath

Jail directory.

-> FilePath

Filename to jail.

-> Maybe FilePath

Jail a filepath within a jail directory.

(/+) :: FilePath -> FilePath -> FilePath

Concatenate and normalize two filepaths.