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

pkl.experimental.structuredRead.structuredRead1.0.3

Properties
Methods
Classes
Type Aliases

module pkl.experimental.structuredRead.structuredRead

Module URI:: package://pkg.pkl-lang.org/pkl-pantry/pkl.experimental.structuredRead@1.0.3#/structuredRead.pkl
Source code:: structuredRead.pkl
Known subtypes:
Known usages:
All versions:: 1.0.3, 1.0.2, 1.0.1, 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

fromEnv: moduleSource

Configures structureRead to read from environment variables

import "structuredRead.pkl"

class Environment {
  SHELL: String
  PWD: String
  USER: Int
}

environment = structuredRead.fromEnv.fill(Environment)

link

hidden

fromExternalProps: moduleSource

Configures structureRead to read from external properties

import "structuredRead.pkl"

class Config {
  name: String
  location: String
  age: Int
}

config = structuredRead.fromHttps.fill(Config)

link

hidden

fromHttps: moduleSource

Configures structureRead to read from https:// resources

import "structuredRead.pkl"

Data {
  `apple.com` {}
}

data = structuredRead.fromHttps.fill(Data)

link

hidden

inputScheme: String(matches(Regex(#"[\w-]+:"#)))Source

The scheme used to read resources from.

By default, this is "prop:" so values are read from external properties passed using the -p flag.
link

hidden

pathSeparator: String Source

Path separator used to when building resource URI.

Default is . which means that nested values are passed in using a dot seperated path as the key value.
link

hidden

pathTemplate: (List<String>) -> String Source

Template used to convert a path of elements into a resource URI.

Default joins the path components with pathSeparator and prepends the inputScheme.
link

hidden

readFunc: unknownSource

Debug hook for overriding how values are read.
link

hidden

classHandlers: Mapping<Class, (String) -> Any>Source

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

fill(target: Class|Module|Dynamic): unknownSource

Takes a given class or module and attempts to fill the properties from external resources.

Resources are read in by constructing resource URIs from the structure of the provided class or modules. The read values are then coerced into the types specified in the class or module, making it easy to get external properties (using fromExternalProps and passed using the -p flag) or environment variables (using fromEnv) into a structured and typed format.

When embeded in another application, this Pkl module can be used to provide a basic ability to override loaded configuration using CLI flags. The application will need to parse the passed flags, then provide them to Pkl via a custom Resource Reader, or by passing them in as external properties.
link

function

applyToClass(target: Class, path: List<String>): Mapping<String, Any?>Source

Classes

link

abstract class

Failure Source
link

class

ReadFailure extends Failure Source
link

class

CoerceFailure extends Failure Source

Type Aliases

link

typealias

Coerceable = DeclaredType|NullableType|TypeAlias|UnknownType Source