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

pkl.experimental.net.net1.2.0

Properties
Methods
Classes
Type Aliases

module pkl.experimental.net.net

We sell IP addresses and IP address accessories This module contains types and functions for handling network (IP and MAC) addresses

Module URI:: package://pkg.pkl-lang.org/pkl-pantry/pkl.experimental.net@1.2.0#/net.pkl
Pkl version:: 0.25.0 or higher
Source code:: net.pkl
Known subtypes:
Known usages:
All versions:: 1.2.1, 1.2.0, 1.1.1, 1.1.0, 1.0.0

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

hidden

hex: String Source
link

hidden

decByte: String Source
link

hidden

ipv4String: unknownSource
link

hidden

ipv6String: unknownSource
link

hidden

nonGlobalIPv6String: unknownSource

Methods(show inherited)

link

function

getClass(): Class (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: (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

IP(ip: IPAddressString): IPAddress Source

Creates an IPAddress from an IPAddressString.
link

function

IPv4Address(ip: IPv4AddressString): IPv4Address Source

Creates an IPv4Address from an IPv4AddressString.
link

function

IPv6Address(ip: IPv6AddressString): IPv6Address Source

Creates an IPv6Address from an IPv6AddressString.
link

function

IPNetwork(cidr: IPCIDRString): IPNetwork Source

Creates an IPNetwork from an IPv4 or IPv6 CIDR block string
link

function

IPv4Network(cidr: IPv4CIDRString): IPv4Network Source

Creates an IPv4Network from an IPv4 CIDR block string
link

function

IPv4Range(start: IPv4Address, end: IPv4Address): Listing<IPv4Address>Source

Produces a listing of IPv4 addresses between start and end, inclusive.
link

function

IPv6Network(cidr: IPv6CIDRString): IPv6Network Source

Creates an IPv6Network from an IPv6 CIDR block string
link

function

IPv6Range(start: IPv6Address, end: IPv6Address): Listing<IPv6Address>Source

Produces a listing of IPv6 addresses between start and end, inclusive.

If both start.scopeId and end.scopeId are equal, the resulting addresses will have the same scope ID, otherwise their scopeId will be null.
link

function

expandIPv6AddressString(_ip: IPv6AddressString): IPv6AddressString Source

Canonicalizes IPv6 addresses by expanding each component to be 4 digits (zero-padded) and expanding ::

Given input "123:45:6::7890", the output is "0123:0045:0006:0000:0000:0000:0000:7890".

If the input is in the alternate form with a trailing IPv4 address, the trailing IPv4 address will be kept intact, although any leading zeroes on the IPv4 components will be dropped.
link

function

compressIPv6AddressString(ip: IPv6AddressString): IPv6AddressString Source

Compresses IPv6 addresses by stripping leading zeros from each component and collapsing repeated zero components to ::.

Given input "0123:0045:0006:0000:0000:0000:0000:7890", the output is "123:45:6::7890".

If there are multiple possible spans of zeroes to collapse, the longest span is chosen. If there are multiple candidates for longest span, the first such span is chosen. The output is consistent with RFC5952 §4.2.3.
link

function

MACAddress(mac: MACAddressString): MACAddress Source
link

function

parseHex(digit: Char): UInt8 Source

parseHex tranforms a single hexadecimal character into its unsigned integer representation.
link

function

parseHexOctet(octet: String(length == 2)): UInt8 Source

parseHexOctet tranforms a two hexadecimal characters into its unsigned integer representation.
link

function

parseHex32(s: String(length == 8)): UInt32 Source

parseHex32 transforms an 8 character hexidecimal string into its UInt32 representation.
link

function

mask32Hi(prefix: UInt(isBetween(0, 32))): UInt32 Source

mask32Hi generates a mask of 1s in the top prefix bits of a UInt32.
link

function

mask32Lo(suffix: UInt(isBetween(0, 32))): UInt32 Source

mask32Lo generates a mask of 1s in the bottom suffix bits of a UInt32.
link

function

uint32FromBytes(hihi: UInt8, hilo: UInt8, lohi: UInt8, lolo: UInt8): UInt32 Source

uint32FromBytes constructs a UInt32 from four UInt8 values.

Classes

link

class

IPv4Address Source

An IPv4 address.
link

class

IPv6Address Source

An IPv6 address.
link

class

IPv4Network Source

An IPv4 network.
link

class

IPv6Network Source

An IPv6 network.
link

class

MACAddress Source

Type Aliases

link

typealias

MACAddressString = String(matches(Regex(#"(\#(net.hex){1,2}[\.:-]){5}(\#(net.hex){1,2})"#)))Source

A string that contains a MAC address
link

typealias

IPAddressString = IPv4AddressString|IPv6AddressString Source

A string that contains either an IPv4 or IPv6 address.
link

typealias

IPAddressPortString = IPv4AddressPortString|IPv6AddressPortString Source

A string that contains either an IPv4 or IPv6 address and port.
link

typealias

IPCIDRString = IPv4CIDRString|IPv6CIDRString Source

A string that contains either an IPv4 or IPv6 CIDR range.
link

typealias

IPAddress = IPv4Address|IPv6Address Source

An IPv4 or IPv6 address.
link

typealias

IPNetwork = IPv4Network|IPv6Network Source

An IPv4 or IPv6 network.
link

typealias

IPv4AddressString = String(matches(Regex(net.ipv4String)))Source

A string that contains an IPv4 address.
link

typealias

IPv6AddressString = String(matches(Regex(net.ipv6String)))Source

A string that contains an IPv6 address.

IPv6 unicast and multicast addresses of non-global scope except for the unspecified address and the loopback address may include a scope ID suffix, e.g. "fe80::1234%1". Site-local unicast addresses (fec0::/10) are deprecated and thus are considered to be global unicast addresses.
link

typealias

IPv4AddressPortString = String(matches(Regex(#"\#(net.ipv4String):[0-9]{1,5}"#)))Source

A string that contains an IPv4 address and port.
link

typealias

IPv6AddressPortString = String(matches(Regex(#"\[\#(net.ipv6String)\]:[0-9]{1,5}"#)))Source

A string that contains an IPv6 address and port.
link

typealias

IPv4CIDRString = String(matches(Regex(#"\#(net.ipv4String)/[0-9]{1,2}"#)))Source

A string that contains an IPv4 address.
link

typealias

IPv6CIDRString = String(matches(Regex(#"\#(net.ipv6String)/[0-9]{1,3}"#)))Source

A string that contains an IPv6 address.