Enum tvix_castore::Node

pub enum Node {
    Directory {
        digest: B3Digest,
        size: u64,
    },
    File {
        digest: B3Digest,
        size: u64,
        executable: bool,
    },
    Symlink {
        target: SymlinkTarget,
    },
}

A Node is either a [DirectoryNode], [FileNode] or [SymlinkNode]. Nodes themselves don’t have names, what gives them names is either them being inside a Directory, or a root node with its own name attached to it.

Variants

Directory

A DirectoryNode is a pointer to a Directory, by its Directory::digest. It also records asize. Such a node is either an element in the Directory it itself is contained in, or a standalone root node.

Fields

digest: B3Digest

The blake3 hash of a Directory message, serialized in protobuf canonical form.

size: u64

Number of child elements in the Directory referred to by digest. Calculated by summing up the numbers of nodes, and for each directory, its size field. Can be used for inode allocation. This field is precisely as verifiable as any other Merkle tree edge. Resolve digest, and you can compute it incrementally. Resolve the entire tree, and you can fully compute it from scratch. A credulous implementation won’t reject an excessive size, but this is harmless: you’ll have some ordinals without nodes. Undersizing is obvious and easy to reject: you won’t have an ordinal for some nodes.

File

A FileNode represents a regular or executable file in a Directory or at the root.

Fields

digest: B3Digest

The blake3 digest of the file contents

size: u64

The file content size

executable: bool

Whether the file is executable

Symlink

A SymlinkNode represents a symbolic link in a Directory or at the root.

Fields

target: SymlinkTarget

The target of the symlink.

Trait Implementations

impl Clone for Node

fn clone(&self) -> Node

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Node

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Node

fn eq(&self, other: &Node) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Node

impl StructuralPartialEq for Node