URI.URI

data URI userInfo hosts path hierPath query fragment

A general purpose absolute URI - similar to AbsoluteURI but also admits a fragment component. An absolute URI can still contain relative paths but is required to have a Scheme component.

Constructors

• URI Scheme (HierarchicalPart userInfo hosts path hierPath) (Maybe query) (Maybe fragment)

Instances

• (Eq userInfo, Eq hosts, Eq path, Eq hierPath, Eq query, Eq fragment) => Eq (URI userInfo hosts path hierPath query fragment)
• (Ord userInfo, Ord hosts, Ord path, Ord hierPath, Ord query, Ord fragment) => Ord (URI userInfo hosts path hierPath query fragment)
• Generic (URI userInfo hosts path hierPath query fragment) _
• (Show userInfo, Show hosts, Show path, Show hierPath, Show query, Show fragment) => Show (URI userInfo hosts path hierPath query fragment)

type URIOptions userInfo hosts path hierPath query fragment = URIParseOptions userInfo hosts path hierPath query fragment (URIPrintOptions userInfo hosts path hierPath query fragment ())

A row type for describing the options fields used by the URI parser and printer.

Used as Record (URIOptions userInfo hosts path hierPath query fragment) when type anotating an options record.

See below for details of how to use these configuration options.

type URIParseOptions userInfo hosts path hierPath query fragment r = (parseFragment :: Fragment -> Either URIPartParseError fragment, parseHierPath :: Either PathAbsolute PathRootless -> Either URIPartParseError hierPath, parseHosts :: Parser String hosts, parsePath :: Path -> Either URIPartParseError path, parseQuery :: Query -> Either URIPartParseError query, parseUserInfo :: UserInfo -> Either URIPartParseError userInfo | r)

A row type for describing the options fields used by the URI parser.

Used as Record (URIParseOptions userInfo hosts path hierPath query fragment ()) when type anotating an options record.

Having this options record allows custom representations to be used for the URI components. If this is not necessary, pure can be used for all the options aside from parseHosts, which will typically be HostPortPair.parseHosts pure pure. See URI.HostPortPair for more information on the host/port pair parser.

type URIPrintOptions userInfo hosts path hierPath query fragment r = (printFragment :: fragment -> Fragment, printHierPath :: hierPath -> Either PathAbsolute PathRootless, printHosts :: hosts -> String, printPath :: path -> Path, printQuery :: query -> Query, printUserInfo :: userInfo -> UserInfo | r)

A row type for describing the options fields used by the URI printer.

Used as Record (URIPrintOptions userInfo hosts path hierPath query fragment ()) when type anotating an options record.

As a reverse of the parse options, this specifies how to print values back from custom representations. If this is not necessary, identity can be used for all the options aside from printHosts, which will typically be HostPortPair.printHosts identity identity. See URI.HostPortPair for more information on the host/port pair printer.

parser :: forall userInfo hosts path hierPath query fragment r. Record (URIParseOptions userInfo hosts path hierPath query fragment r) -> Parser String (URI userInfo hosts path hierPath query fragment)

A parser for a URI.

print :: forall userInfo hosts path hierPath query fragment r. Record (URIPrintOptions userInfo hosts path hierPath query fragment r) -> URI userInfo hosts path hierPath query fragment -> String

A printer for a URI.

_scheme :: forall userInfo hosts path hierPath query fragment. Lens' (URI userInfo hosts path hierPath query fragment) Scheme

The scheme component of a URI.

_hierPart :: forall userInfo hosts path hierPath query fragment. Lens' (URI userInfo hosts path hierPath query fragment) (HierarchicalPart userInfo hosts path hierPath)

The hierarchical-part component of a URI.

_query :: forall userInfo hosts path hierPath query fragment. Lens' (URI userInfo hosts path hierPath query fragment) (Maybe query)

The query component of a URI.

_fragment :: forall userInfo hosts path hierPath query fragment. Lens' (URI userInfo hosts path hierPath query fragment) (Maybe fragment)

The fragment component of a URI.

newtype UserInfo

The user info part of an Authority. For example: user, foo:bar.

This type treats the entire string as an undifferentiated blob, if you would like to specifically deal with the user:password format, take a look at URI.Extra.UserPassInfo.

Instances

• Eq UserInfo
• Ord UserInfo
• Semigroup UserInfo
• Show UserInfo

newtype RegName

The reg-name variation of the host part of a URI. A reg-name is probably more commonly referred to as just a host name or domain name (but it is actually a name, rather than an IP address).

Instances

• Eq RegName
• Ord RegName
• Semigroup RegName
• Show RegName

newtype Port

The port component of a host in a URI.

Instances

• Eq Port
• Ord Port
• Show Port

newtype PathRootless

A relative path, corresponding to path-rootless in the spec. This path cannot start with the character / or be entirely empty. This type can appear in a hierarchical-part when there is no authority component.

Constructors

• PathRootless (Tuple PathSegmentNZ (Array PathSegment))

Instances

• Eq PathRootless
• Ord PathRootless
• Generic PathRootless _
• Show PathRootless

newtype PathAbsolute

An absolute path, corresponding to path-absolute in the spec. This path cannot represent the value // - it must either be /, or start with a segment that is not empty, for example: /something, /., /... This type can appear in both hierarchical-part and relative-parts to represent an absolute path when no authority component is present.

This restriction exists as a value begining with // at this point in the grammar must be an authority, attempting to decide whether a value is an authority or a path would be ambiguous if // paths were allowed. The // path means the same thing as / anyway!

Constructors

• PathAbsolute (Maybe (Tuple PathSegmentNZ (Array PathSegment)))

Instances

• Eq PathAbsolute
• Ord PathAbsolute
• Generic PathAbsolute _
• Show PathAbsolute

newtype Path

A generic absolute-or-empty path, used in both hierarchical-part and relative-parts when an authority component is present. Corresponds to path-abempty in the spec.

A path value of / corresponds to Path [""], an empty path is Path [].

Constructors

• Path (Array PathSegment)

Instances

• Eq Path
• Ord Path
• Semigroup Path
• Monoid Path
• Generic Path _
• Show Path

newtype IPv6Address

This type and parser are much too forgiving currently, allowing almost anything through that looks vaguely IPv6ish.

Instances

• Eq IPv6Address
• Ord IPv6Address
• Show IPv6Address

data IPv4Address

The IPv4 address variation of the host part of a URI.

Instances

• Eq IPv4Address
• Ord IPv4Address
• Show IPv4Address

data Host

A host address. Supports named addresses, IPv4, and IPv6.

Constructors

• IPv6Address IPv6Address
• IPv4Address IPv4Address
• NameAddress RegName

Instances

• Eq Host
• Ord Host
• Generic Host _
• Show Host

type HierarchicalPartPrintOptions userInfo hosts path hierPath r = (printHierPath :: hierPath -> HierPath, printHosts :: hosts -> String, printPath :: path -> Path, printUserInfo :: userInfo -> UserInfo | r)

A row type for describing the options fields used by the hierarchical-part printer.

Used as Record (HierarchicalPartPrintOptions userInfo hosts path hierPath ()) when type anotating an options record.

type HierarchicalPartParseOptions userInfo hosts path hierPath r = (parseHierPath :: HierPath -> Either URIPartParseError hierPath, parseHosts :: Parser String hosts, parsePath :: Path -> Either URIPartParseError path, parseUserInfo :: UserInfo -> Either URIPartParseError userInfo | r)

A row type for describing the options fields used by the hierarchical-part parser.

Used as Record (HierarchicalPartParseOptions userInfo hosts path hierPath ()) when type anotating an options record.

type HierarchicalPartOptions userInfo hosts path hierPath = HierarchicalPartParseOptions userInfo hosts path hierPath (HierarchicalPartPrintOptions userInfo hosts path hierPath ())

A row type for describing the options fields used by the hierarchical-part parser and printer.

Used as Record (HierarchicalPartOptions userInfo hosts path hierPath) when type anotating an options record.

data HierarchicalPart userInfo hosts path hierPath

The "hierarchical part" of a generic or absolute URI. This combines an authority (optional) with a path value.

When the authority is present a generic path representation can be used, otherwise there are some restrictions on the path construction to ensure no ambiguity in parsing (this is per the spec, not a restriction of the library).

Constructors

• HierarchicalPartAuth (Authority userInfo hosts) path
• HierarchicalPartNoAuth (Maybe hierPath)

Instances

• (Eq userInfo, Eq hosts, Eq path, Eq hierPath) => Eq (HierarchicalPart userInfo hosts path hierPath)
• (Ord userInfo, Ord hosts, Ord path, Ord hierPath) => Ord (HierarchicalPart userInfo hosts path hierPath)
• Generic (HierarchicalPart userInfo hosts path hierPath) _
• (Show userInfo, Show hosts, Show path, Show hierPath) => Show (HierarchicalPart userInfo hosts path hierPath)

type HierPath = Either PathAbsolute PathRootless

The specific path types supported in a hierarchical-part when there is no authority present. See URI.Path.Absolute and URI.Path.Rootless for an explanation of these forms.

type AuthorityPrintOptions userInfo hosts r = (printHosts :: hosts -> String, printUserInfo :: userInfo -> UserInfo | r)

A row type for describing the options fields used by the authority printer.

Used as Record (AuthorityPrintOptions userInfo hosts ()) when type annotating an options record.

type AuthorityParseOptions userInfo hosts r = (parseHosts :: Parser String hosts, parseUserInfo :: UserInfo -> Either URIPartParseError userInfo | r)

A row type for describing the options fields used by the authority parser.

Used as Record (AuthorityParseOptions userInfo hosts ()) when type annotating an options record.

type AuthorityOptions userInfo hosts = AuthorityParseOptions userInfo hosts (AuthorityPrintOptions userInfo hosts ())

A row type for describing the options fields used by the authority parser and printer.

Used as Record (AuthorityOptions userInfo hosts) when type annotating an options record.

data Authority userInfo hosts

The authority part of a URI. For example: purescript.org, localhost:3000, user@example.net.

Constructors

• Authority (Maybe userInfo) hosts

Instances

• (Eq userInfo, Eq hosts) => Eq (Authority userInfo hosts)
• (Ord userInfo, Ord hosts) => Ord (Authority userInfo hosts)
• Generic (Authority userInfo hosts) _
• (Show userInfo, Show hosts) => Show (Authority userInfo hosts)

_userInfo :: forall userInfo hosts. Lens' (Authority userInfo hosts) (Maybe userInfo)

A lens for the user-info component of the authority.

_path :: forall userInfo hosts path hierPath. Traversal' (HierarchicalPart userInfo hosts path hierPath) path

An affine traversal for the path component of a hierarchical-part, this succeeds when the authority is present also.

_hosts :: forall userInfo hosts. Lens' (Authority userInfo hosts) hosts

A lens for the host(s) component of the authority.

_hierPath :: forall userInfo hosts path hierPath. Traversal' (HierarchicalPart userInfo hosts path hierPath) (Maybe hierPath)

An affine traversal for the path component of a hierarchical-part, this succeeds when the authority is not present.

_authority :: forall userInfo hosts path hierPath. Traversal' (HierarchicalPart userInfo hosts path hierPath) (Authority userInfo hosts)

An affine traversal for the authority component of a hierarchical-part.

_NameAddress :: Prism' Host RegName

A prism for the NameAddress constructor.

_IPv6Address :: Prism' Host IPv6Address

A prism for the IPv6Address constructor.

_IPv4Address :: Prism' Host IPv4Address

A prism for the IPv4Address constructor.

newtype Query

The query component of a URI.

This type treats the entire string as an undifferentiated blob, if you would like to deal with the common ?key1=value1&key2=value2 format, take a look at URI.Extra.QueryPairs.

Instances

• Eq Query
• Ord Query
• Semigroup Query
• Monoid Query
• Show Query

newtype Scheme

The scheme part of an absolute URI. For example: http, ftp, git.

Instances

• Eq Scheme
• Ord Scheme
• Show Scheme