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

IPv6Address1.2.1

Properties
Methods

class IPv6Address

An IPv6 address.

Known subtypes:
Known usages:
All versions:

Properties

link

repr: UInt128 Source
link

scopeId: UInt(isNonGlobalScope)?Source

The scope ID associated with this address, or null if the scope is unknown or not applicable.

Only addresses of non-global scope are allowed to have a scope ID.
link

hidden

bitWidth: UInt Source
link

hidden

isUnspecified: Boolean Source

Tells if this address is the unspecified address (::).
link

hidden

isLoopback: Boolean Source

Tells if this address is the loopback address (::1).
link

hidden

isIPv4Mapped: Boolean Source

Tells if this address is an IPv4-mapped address (::ffff:0:0/96).
link

hidden

isIPv4Embedded: Boolean Source

Tells if this address is an IPv4-embedded address using the Well-Known Prefix (64:ff9b::/96) described by RFC 6052 §2.1.
link

hidden

isNonGlobalScope: Boolean Source

Tells if this address has non-global unicast or multicast scope.

Returns true for link-local unicast and for multicast with "scop" field less than global. Returns false for the unspecified address and the loopback address, and for site-local addresses as per RFC 4291 §2.5.7.

Methods(show inherited)

link

function

Any.getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

toString(): IPv6AddressString Source

Returns the IPv6Address in the canonical style described by RFC 5952.

This includes returning the address in the alternative IPv4-suffixed format if it is IPv4-mapped or IPv4-embedded.
link

function

Any.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

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

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

function

Typed.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

Typed.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

Typed.toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

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

Converts this object to a Map.
link

function

maskHi(prefix: UInt(isBetween(0, bitWidth))): UInt128 Source

maskHi generates a mask of 1s in the top prefix bits of a u128.UInt128.
link

function

maskLo(suffix: UInt(isBetween(0, bitWidth))): UInt128 Source

maskLo generates a mask of 1s in the bottom suffix bits of a u128.UInt128.
link

function

reverse(): String Source

reverse returns the PTR record name for this address.
link

function

next(): IPv6Address Source

return the ip address immediately after this one
link

function

add(n: UInt32): IPv6Address Source

return the ip address n after this one
link

function
toExpandedString(): IPv6AddressString Source

Returns the IPv6Address as a string in expanded form.
Example:
```
IPv6Address("fe80::1").toExpandedString() == "fe80:0000:0000:0000:0000:0000:0000:0001"
```