Packages > pkg.pkl-lang.org/pkl-pantry/pkl.experimental.uri

pkl.experimental.uri.URI1.0.3

Overview
Properties
Methods
Type Aliases

module pkl.experimental.uri.URI

A Uniform Resource Identifier as defined by RFC-3986.

Module URI:: package://pkg.pkl-lang.org/pkl-pantry/pkl.experimental.uri@1.0.3#/URI.pkl
Pkl version:: 0.25.0 or higher
Source code:: URI.pkl
Known subtypes:
Known usages:
All versions:

Properties(show inherited)

link

hidden

output: ModuleOutput (pkl.base)Source

The output of this module.

Defaults to all module properties rendered as either Pcf or the format specified on the command line.
link

scheme: String?Source

The scheme component.
link

userInfo: String?Source

The user information portion of the authority component.
link

host: String?Source

The host portion of the authority component.
link

port: UInt16?Source

The port portion of the authority component.
link

path: UriString Source

The path component, URI-encoded.

Access the decoded form of the path via pathSegments.
link

pathSegments: List<String>Source

The URI path split into its segments.

Each segment is decoded.
link

query: UriString?Source

The query component, URI-encoded.
link

fragment: String?Source

The fragment component.
link

hidden

basePath: URI Source

The base path portion of this URI.

This equivalent to the current URI without its query and fragment components.
link

hidden

isAbsolute: Boolean Source

Tells if this URI is an absolute URI.
link

hidden

hasAbsolutePath: Boolean Source

Tells if the path is absolute.

Methods(show inherited)

link

function

getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

toString(): String Source

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.
link

function
relativePathTo(other: Module): List<String> (pkl.base)Source

Returns the relative, descendent directory path between this module and other.
Throws if no such path exists.

For example, if module mod1 has path /dir1/mod1.pkl, and module mod2 has path /dir1/dir2/dir3/mod2.pkl, then mod1.relativePathTo(mod2) will return List("dir2", "dir3").

A common use case is to compute the directory path between a template located at the root of a hierarchy (say rootModule.pkl) and the currently evaluated module (accessible via the module keyword):
```
import "rootModule.pkl" // self-import
path = rootModule.relativePathTo(module)
```
link

function

authority(): String?Source

The authority component of the URI.
link

function

hasAuthority(): Boolean Source

Tells if this URI has an authority.
link

function

resolveUri(other: URI): URI Source

Resolves other as a URI reference to this URI.

Follows the rules described in RFC-3986 Section 5.2.
link

function

resolve(other: String): URI?Source

Resolves other as a URI string to this URI.
link

function
encode(str: String): String Source

Encodes str using percent-encoding bytes to make it safe for the literal use as a URI.
All characters except for alphanumeric chracters, and the chracters !#$&'()*+,-./:;=?@_~ are percent-encoded.

Follows the rules for the encodeURI function as described by ECMA-262.

Facts:
```
encode("https://example.com/some path/") == "https://example.com/some%20path"
```
link

function
encodeComponent(str: String): String Source

Encodes str using percent-encoding to make it safe to literal use as a URI component.
All characters except for alphanumeric characters, and the characters -_.!~*'() are percent-encoded.

Follows the rules for the encodeURIComponent function as described by ECMA-262.

Facts:
```
encodeComponent("https://example.com/some path") == "https%3A%2F%2example.com%2Fsome%20path"
```
link

function

percentDecode(str: String): String Source

Decodes str given a percent-encoded string.
link

function

parseAuthority(authority: String): Dynamic Source
link

function

parse(str: String): URI?Source

Parses the input string as a URI.

If the input is not valid, returns null.

Type Aliases

link

typealias

UriString = String(isUriString)Source

A string that has valid URI characters.