Snapshot overview

Opaque virtual filesystem snapshots and their decoding limits.

Snapshots contain a volume's reachable namespace and metadata, but exclude callers, open handles, watch subscriptions, and unlinked content. Use the encoding, decoding, and restoration functions in VirtualFileSystem.

Added in v0.1.0

errors

ImageError (class)

Describes a snapshot encoding, decoding, structure, or resource-limit failure.

Signature

export declare class ImageError

Added in v0.1.0

models

DecodeLimits (type alias)

Resource limits applied while decoding a snapshot.

Signature

export type DecodeLimits = typeof DecodeLimits.Type;

Added in v0.1.0

Snapshot (interface)

An immutable, opaque capture of a virtual filesystem volume.

Signature

export interface Snapshot {
  readonly [SnapshotTypeId]: SnapshotTypeId;
}

Added in v0.1.0

schemas

DecodeLimits

Schema for the mandatory resource limits applied while decoding a snapshot.

Signature

export declare const DecodeLimits: Schema.Struct<{
  readonly maxEncodedBytes: Schema.ByteSize;
  readonly maxRecords: Schema.Finite;
  readonly maxEntries: Schema.Finite;
  readonly maxDecodedBytes: Schema.ByteSize;
}>;

Added in v0.1.0

type ids

SnapshotTypeId

Type identifier for opaque filesystem snapshots.

Signature

export declare const SnapshotTypeId: typeof SnapshotTypeId;

Added in v0.1.0

SnapshotTypeId (type alias)

Type identifier for opaque filesystem snapshots.

Signature

export type SnapshotTypeId = typeof SnapshotTypeId;

Added in v0.1.0