URI

This module defines the URI and RequestTarget types that represent and manipulate components of URIs as defined by RFC 3986. It provides parsing, rendering, and normalization utilities for working with URIs and request targets in HTTP messages.

References:

• https://www.rfc-editor.org/rfc/rfc3986.html
• https://www.rfc-editor.org/rfc/rfc9112.html#section-3.3

@[inline]

def Std.Http.RequestTarget.parse? (string : String) : Option RequestTarget

Attempts to parse a RequestTarget from the given string.

Equations

• Std.Http.RequestTarget.parse? string = ((Std.Http.URI.Parser.parseRequestTarget <* Std.Internal.Parsec.eof).run string.toUTF8).toOption

@[inline]

def Std.Http.RequestTarget.parse! (string : String) : RequestTarget

Parses a RequestTarget from the given string. Panics if parsing fails. Use parse? if you need a safe option-returning version.

Equations

• One or more equations did not get rendered due to their size.

@[inline]

def Std.Http.RequestTarget.originForm! (path : String) : RequestTarget

Creates an origin-form request target from a path string. The path should start with '/' (e.g., "/api/users" or "/search?q=test"). Panics if the string is not a valid origin-form request target.

Equations

• One or more equations did not get rendered due to their size.

@[inline]

def Std.Http.URI.parse? (string : String) : Option URI

Attempts to parse a URI from the given string.

Equations

• Std.Http.URI.parse? string = ((Std.Http.URI.Parser.parseURI <* Std.Internal.Parsec.eof).run string.toUTF8).toOption

@[inline]

def Std.Http.URI.parse! (string : String) : URI

Parses a URI from the given string. Panics if parsing fails. Use parse? if you need a safe option-returning version.

Equations

• Std.Http.URI.parse! string = match Std.Http.URI.parse? string with | some res => res | none => panicWithPosWithDecl "Std.Internal.Http.Data.URI" "Std.Http.URI.parse!" 77 12 "invalid URI"

@[inline]

def Std.Http.URI.Path.parse? (s : String) : Option Path

Attempts to parse a URI path from the given string. Returns none if the string is not a valid path.

Equations

• Std.Http.URI.Path.parse? s = ((Std.Http.URI.Parser.parsePath { } true true <* Std.Internal.Parsec.eof).run s.toUTF8).toOption

@[inline]

def Std.Http.URI.Path.parseOrRoot (s : String) : Path

Parses a URI path from the given string. Returns the root path "/" if parsing fails.

Equations

• Std.Http.URI.Path.parseOrRoot s = (Std.Http.URI.Path.parse? s).getD { segments := #[], absolute := true }