Documentation
¶
Overview ¶
Package pkg define CUE standard packages.
Many of the standard packages are modeled after and generated from the Go core packages. The types, values, and functions are defined as their Go equivalence and mapped to CUE types.
Beware that some packages are defined in lesser-precision types than are typically used in CUE and thus may lead to loss of precision.
All packages except those defined in the tool subdirectory are hermetic, that is depending only on a known set of inputs, and therefore can guarantee reproducible results. That is:
- no reading of files contents
- no querying of the file system of any kind
- no communication on the network
- no information about the type of environment
- only reproduceable random generators
Hermetic configurations allow for fast and advanced analysis that otherwise would not be possible or practical. The cue "cmd" command can be used to mix in non-hermetic influences into configurations by using packages defined in the tool subdirectory.
Directories
¶
| Path | Synopsis |
|---|---|
|
crypto
|
|
|
hmac
Package hmac implements the Keyed-Hash Message Authentication Code (HMAC) as defined in U.S. Federal Information Processing Standards Publication 198.
|
Package hmac implements the Keyed-Hash Message Authentication Code (HMAC) as defined in U.S. Federal Information Processing Standards Publication 198. |
|
encoding
|
|
|
base64
Package base64 implements base64 encoding as specified by RFC 4648.
|
Package base64 implements base64 encoding as specified by RFC 4648. |
|
Package gen is a command that can be used to bootstrap a new builtin package directory.
|
Package gen is a command that can be used to bootstrap a new builtin package directory. |
|
Package list contains functions for manipulating and examining lists.
|
Package list contains functions for manipulating and examining lists. |
|
Package net provides net-related type definitions.
|
Package net provides net-related type definitions. |
|
Package filepath implements utility routines for manipulating filename paths in a way compatible with the target operating system-defined file paths.
|
Package filepath implements utility routines for manipulating filename paths in a way compatible with the target operating system-defined file paths. |
|
Package regexp implements regular expression search.
|
Package regexp implements regular expression search. |
|
Package strings implements simple functions to manipulate UTF-8 encoded strings.package strings.
|
Package strings implements simple functions to manipulate UTF-8 encoded strings.package strings. |
|
Package struct defines utilities for struct types.
|
Package struct defines utilities for struct types. |
|
text
|
|
|
Package time defines time-related types.
|
Package time defines time-related types. |
|
Package tool defines statefull operation types for cue commands.
|
Package tool defines statefull operation types for cue commands. |
|
cli
Package cli provides tasks dealing with a console.
|
Package cli provides tasks dealing with a console. |
|
exec
Package exec defines tasks for running commands.
|
Package exec defines tasks for running commands. |
|
file
Package file provides file operations for cue tasks.
|
Package file provides file operations for cue tasks. |
|
http
Package http provides tasks related to the HTTP protocol.
|
Package http provides tasks related to the HTTP protocol. |
|
os
Package os defines tasks for retrieving os-related information.
|
Package os defines tasks for retrieving os-related information. |
|
Package uuid defines functionality for creating UUIDs as defined in RFC 4122.
|
Package uuid defines functionality for creating UUIDs as defined in RFC 4122. |