Iri.Data

References:

• URI RFC
• IRI RFC

Documentation

data Iri

Thorough structure of IRI.

Constructors

Iri !Scheme !Hierarchy !Query !Fragment

newtype Scheme

Constructors

Scheme ByteString

data Hierarchy

Constructors

AuthorisedHierarchy !Authority !Path

AbsoluteHierarchy !Path

RelativeHierarchy !Path

data Authority

Constructors

Authority !UserInfo !Host !Port

data UserInfo

Constructors

PresentUserInfo !User !Password

MissingUserInfo

newtype User

Constructors

User Text

data Password

Constructors

PresentPassword !Text

MissingPassword

data Host

Constructors

NamedHost !RegName

IpV4Host !IPv4

IpV6Host !IPv6

newtype RegName

Constructors

RegName (Vector DomainLabel)

newtype DomainLabel

Constructors

DomainLabel Text

data Port

Constructors

PresentPort !Word16

MissingPort

newtype Path

Constructors

Path (Vector PathSegment)

newtype PathSegment

Constructors

PathSegment Text

newtype Query

Since the exact structure of the query string is not standardised and methods used to parse the query string may differ between websites, we simply represent it as a decoded Unicode string.

See https://en.wikipedia.org/wiki/Query_string.

Constructors

Query Text

newtype Fragment

Constructors

Fragment Text

Special cases

HTTP special case

data HttpIri

HTTP being by far the most common use-case for resource identifiers, it's been isolated into a dedicated data-type, which is optimised for that particular case.

Compared to the general IRI definition it:

• only supports the HTTP and HTTPS schemes
• misses the Username and Password components
• requires the Host component
• requires the Path component to be absolute

Constructors

HttpIri !Security !Host !Port !Path !Query !Fragment

newtype Security

Constructors

Security Bool

httpIriFromIri :: Iri -> Either Text HttpIri

Try to specialize a general IRI to HTTP

iriFromHttpIri :: HttpIri -> Iri

Generalize an HTTP IRI to IRI