Packages > pkl

pkl.net0.33.0

Properties
Methods
Classes

module pkl.net

Utilities for networking, like URL parsing.

Module URI:: pkl:net
Pkl version:: 0.33.0 or higher
Known subtypes in package:
Known usages in package:
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.

Methods(show inherited)

link

function

getClass(): Class<this> (pkl.base)Source

Returns the class of this.
link

function

toString(): String (pkl.base)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: (this) -> 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
Url(input: String): Url

Constructs a Url as described by input, following RFC 3986. Accepts a URL reference (one without a scheme).
This is lenient: whatever a component cannot hold literally is percent-encoded, and whatever is already percent-encoded is kept as is.

Throws if input is not a valid URL.

To test if input is a valid URL, use String.isValidUrl.

Facts:
```
net.Url("https://example.com/foo?a=1").host == "example.com"
net.Url("https://example.com/foo?a=1").query == "a=1"
net.Url("https://example.com/a b").rawPath == "/a%20b"
net.Url("/foo").scheme == null
```
link

function
encodeUrlComponent(value: String): String

Percent-encodes value so that it can be interpolated into any URL component.
Every character other than an ASCII alphanumeric or one of -._~, the unreserved characters of RFC 3986, is percent-encoded as its UTF-8 bytes.

Facts:
```
net.encodeUrlComponent("a b&c") == "a%20b%26c"
net.encodeUrlComponent("50%") == "50%25"
```
link

function
decodeUrlComponent(value: String): String

Percent-decodes value, interpreting the decoded bytes as UTF-8.
Throws if any % in value does not begin a percent-encoded octet. To write a literal %, encode it as %25.

Facts:
```
net.decodeUrlComponent("a%20b%26c") == "a b&c"
net.decodeUrlComponent("50%25") == "50%"
```
link

function
buildQuery(parameters: Mapping<String, Listing<String>>): String

Builds a query from parameters, for use as a Url.rawQuery.
The result is application/x-www-form-urlencoded. A name is written once per value it holds; one that holds no values is left out entirely.

Url.queryParameters reads back exactly the parameters given here, less any name that holds no values.

Facts:
```
net.buildQuery(new Mapping { ["q"] = new Listing { "a b" } }) == "q=a+b"
net.buildQuery(new Mapping { ["a"] = new Listing { "1"; "2" } }) == "a=1&a=2"
net.buildQuery(new Mapping { ["a"] = new Listing { "1" }; ["b"] = new Listing {} }) == "a=1"
```
link

function
parseQuery(query: String): Mapping<String, Listing<String>>

Reads query back into its parameters.
query is read as application/x-www-form-urlencoded. A name that repeats holds the values of all its occurrences, in the order they are written. A parameter that states no = holds no value at all, and is left out.

Throws if any % in query does not begin a percent-encoded octet.

Facts:
```
net.parseQuery("a=1&a=2") == new Mapping { ["a"] = new Listing { "1"; "2" } }
net.parseQuery("q=a+b&bare") == new Mapping { ["q"] = new Listing { "a b" } }
```

Classes

link

class

Url

A URL, as defined by RFC 3986. RFC 6874 IPv6 zone literals are also supported.