Package-level declarations

Types

Link copied to clipboard
class Bundle
Link copied to clipboard
class BundleArtifacts : GeneratedMessage, BundleArtifactsOrBuilder
# VFS: Bundle Artifacts

Structure of the JSON file which is embedded in a bundle file to enable easy inspection of filesystem contents. The
artifacts file is always appended at the end of the outer bundle tarball, and is always named `artifacts.json.gz`, to
reflect that it is always gzip-encoded.

The artifacts file specifies the following information for each artifact embedded within the file-system:
- The active compression format.
- The artifact's name (path).
- Several hashes of the artifact's un-compressed contents.
- The artifact's un-compressed size.
- The artifact's compressed size using the active compression format.
- The artifact's compressed-data CRC32 checksum.
Protobuf type elide.vfs.BundleArtifacts
Link copied to clipboard

Protobuf type elide.vfs.BundleArtifacts

Link copied to clipboard
interface BundleArtifactsOrBuilder : MessageOrBuilder
Link copied to clipboard
class BundleHeader : GeneratedMessage, BundleHeaderOrBuilder
# VFS: Bundle Header

Defines the packed layout of an Elide VFS bundle's file header. The file header contains just enough data to safely
de-compress and unpack the file-tree metadata, and the associated raw filesystem data. The header is designed to
evolve over time; the format version, at this time, is always `1`.
Protobuf type elide.vfs.BundleHeader
Link copied to clipboard

Protobuf type elide.vfs.BundleHeader

Link copied to clipboard
interface BundleHeaderOrBuilder : MessageOrBuilder
Link copied to clipboard
class BundleInfo : GeneratedMessage, BundleInfoOrBuilder
# VFS: Bundle Info

Structure which defines a full suite of metadata for a given VFS bundle file. This record is only used during
construction or loading of the bundle, as a utility; it is never serialized into the bundle itself.
Protobuf type elide.vfs.BundleInfo
Link copied to clipboard

Protobuf type elide.vfs.BundleInfo

Link copied to clipboard
interface BundleInfoOrBuilder : MessageOrBuilder
Link copied to clipboard
class Config
Link copied to clipboard
class Directory : GeneratedMessage, DirectoryOrBuilder
# VFS: Directory

Describes a directory-type entry within a given `TreeEntry`, within a virtual file system managed by Elide. Directory
entries can hold children (either `File` or other `Directory` objects), by way of their `TreeEntry` children. Entries
of type `Directory` are virtualized and carry no data.
Protobuf type elide.vfs.Directory
Link copied to clipboard

Protobuf type elide.vfs.Directory

Link copied to clipboard
interface DirectoryOrBuilder : MessageOrBuilder
Link copied to clipboard
class File : GeneratedMessage, FileOrBuilder
# VFS: File

Describes a single `File`-type entry within a given `TreeEntry`, within a virtual file system managed by Elide. File
entries describe file metadata only; raw file data is enclosed in a compressed blob stored alongside filesystem
metadata.

See individual properties for more information. `File` objects can only be held by `TreeEntry` objects. `Directory`
objects refer to their child `TreeEntry` constituents.
Protobuf type elide.vfs.File
Link copied to clipboard
object FileKt

Protobuf type elide.vfs.File

Link copied to clipboard
interface FileOrBuilder : MessageOrBuilder
Link copied to clipboard
Link copied to clipboard
class Filesystem : GeneratedMessage, FilesystemOrBuilder
# VFS: File System

Describes a root singleton metadata record which points to the root `TreeEntry` of a given virtual file system
managed by Elide. Only one `Filesystem` may exist per image.
Protobuf type elide.vfs.Filesystem
Link copied to clipboard

Protobuf type elide.vfs.Filesystem

Link copied to clipboard
interface FilesystemOrBuilder : MessageOrBuilder
Link copied to clipboard
class GuestVFSConfig : GeneratedMessage, GuestVFSConfigOrBuilder
# VFS: Configuration

Describes construction-time configuration values which are used to create a virtual file system for a guest VM. These
properties describe such settings as read-only status, support for virtual links, and so on. Guest VFS configuration
is typically derived at runtime from a combination of VFS policy (see [GuestVFSPolicy]) and top-level VM config.
Protobuf type elide.vfs.GuestVFSConfig
Link copied to clipboard

Protobuf type elide.vfs.GuestVFSConfig

Link copied to clipboard
interface GuestVFSConfigOrBuilder : MessageOrBuilder
Link copied to clipboard
class GuestVFSPolicy : GeneratedMessage, GuestVFSPolicyOrBuilder
# VFS: Policy

Specifies configuration values which are included in a guest VM configuration record, and which relate to the guest
VM's behavior for file system access.
Protobuf type elide.vfs.GuestVFSPolicy
Link copied to clipboard

Protobuf type elide.vfs.GuestVFSPolicy

Link copied to clipboard
interface GuestVFSPolicyOrBuilder : MessageOrBuilder
Link copied to clipboard
enum KnownMimeType : ProtocolMessageEnum
# VFS: Known MIME-Type

Enumerates known mime-types to the VM implementation, which can be expressed symbolically rather than in string form.
These types are only created for files which are expected to be frequently used by the VM FS.
Protobuf enum elide.vfs.KnownMimeType
Link copied to clipboard
class Tree
Link copied to clipboard
class TreeEntry : GeneratedMessage, TreeEntryOrBuilder
# VFS: Tree Entry

Describes a single entry within a given virtual file system managed by Elide. Tree entries can hold `File` or
`Directory` objects. Directories can, themselves, hold child `TreeEntry` objects, but files cannot.
Protobuf type elide.vfs.TreeEntry
Link copied to clipboard

Protobuf type elide.vfs.TreeEntry

Link copied to clipboard
interface TreeEntryOrBuilder : MessageOrBuilder

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
@JvmName(name = "-initializebundleArtifacts")
inline fun bundleArtifacts(block: BundleArtifactsKt.Dsl.() -> Unit): BundleArtifacts
Link copied to clipboard
@JvmName(name = "-initializebundleHeader")
inline fun bundleHeader(block: BundleHeaderKt.Dsl.() -> Unit): BundleHeader
Link copied to clipboard
@JvmName(name = "-initializebundleInfo")
inline fun bundleInfo(block: BundleInfoKt.Dsl.() -> Unit): BundleInfo
Link copied to clipboard
@JvmName(name = "-initializedirectory")
inline fun directory(block: DirectoryKt.Dsl.() -> Unit): Directory
Link copied to clipboard
@JvmName(name = "-initializefile")
inline fun file(block: FileKt.Dsl.() -> Unit): File
Link copied to clipboard
@JvmName(name = "-initializefilesystem")
inline fun filesystem(block: FilesystemKt.Dsl.() -> Unit): Filesystem
Link copied to clipboard
@JvmName(name = "-initializeguestVFSConfig")
inline fun guestVFSConfig(block: GuestVFSConfigKt.Dsl.() -> Unit): GuestVFSConfig
Link copied to clipboard
@JvmName(name = "-initializeguestVFSPolicy")
inline fun guestVFSPolicy(block: GuestVFSPolicyKt.Dsl.() -> Unit): GuestVFSPolicy
Link copied to clipboard
@JvmName(name = "-initializetreeEntry")
inline fun treeEntry(block: TreeEntryKt.Dsl.() -> Unit): TreeEntry