Packages > pkg.pkl-lang.org/pkl-pantry/pkl.tar > pkl.tar.File

RegularFile0.1.0

Properties
Methods

class RegularFile extends File

A regular file with contents from a FileOutput.

Known subtypes in package:
Known usages in package:
All versions:

Properties(show inherited)

link

hidden

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

type: "0"Source

File type marker, also known as linkflag.
link

File.typeByte: UInt8 (pkl.tar.File)Source

The numeric byte value of type.
link

File.info: Info? (pkl.tar.File)Source

File information.
link

File.paxFields: PaxFields (pkl.tar.File)Source

Pax archive extended header data fields.
link

File.effectivePaxFields: PaxFields (pkl.tar.File)Source
link

paddedBytes: Buffer Source

The payload bytes of this file, padded to the nearest 512 bytes.
link

File.blankInfo: Info (pkl.tar.File)Source

A "blank" Info used as default metadata for pax extended headers.
link

File.endOfArchive: Buffer (pkl.tar.File)Source

The end-of-archive indicator: 1024 bytes of zero bytes.
link

file: FileOutput Source

The file contents to archive.

Must have bytes.length < 2**33 for UStar archives.
link

fileSize: UInt Source

The length of file in bytes.

Methods(show inherited)

link

function

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

Returns the class of this.
link

function

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

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

makeHeader(path: String, pax: Pax?): Block Source

Generate the UStar header for this file including type-specific customizations.
link

function

File.makeBaseHeader(path: String, pax: Pax?): Block (pkl.tar.File)Source

Generate the UStar header for this file before type-specific customatizations.
link

function

File.makePax(path: String, pax: Pax): Buffer(length % blockLength == 0) (pkl.tar.File)Source

Generate the pax header and payload for this file, if enabled and applicable.
link

function

File.nul(length: Int): Buffer (pkl.tar.File)Source

Return a List of zero bytes of the specified length.
link

function
File.checksum(header: Block): Block (pkl.tar.File)Source

Given a header Block, return the same block with its checksum calculated.
Procedure:
1. Replace the 8 byte checksum fields with ASCII spaces (0x20).
2. Sum every byte in the header block.
3. Encode as a 6 digit octal number, followed by a NUL and then a space.
4. Replace the 8 byte checksum field with the encoded checksum.
- This impl reuses the blanked checksum header and replaces the first 7 bytes with the sum.
link

function

File.maybeAppend(cond: Boolean, makeBuffer: () -> Buffer): (Buffer) -> Buffer (pkl.tar.File)Source

Utility Mixin for evaluating and adding (+) a Buffer only if cond is true.