Struct tvix_castore::nodes::directory::Directory

pub struct Directory {
    nodes: BTreeMap<PathComponent, Node>,
}

A Directory contains nodes, which can be Directory, File or Symlink nodes. It attaches names to these nodes, which is the basename in that directory. These names:

• MUST not contain slashes or null bytes
• MUST not be ‘.’ or ‘..’
• MUST be unique across all three lists

Fields

nodes: BTreeMap<PathComponent, Node>

Implementations

impl Directory

pub fn new() -> Self

Constructs a new, empty Directory.

pub fn try_from_iter<T: IntoIterator<Item = (PathComponent, Node)>>( iter: T, ) -> Result<Directory, DirectoryError>

Construct a Directory from tuples of name and Node.

Inserting multiple elements with the same name will yield an error, as well as exceeding the maximum size.

pub fn size(&self) -> u64

The size of a directory is the number of all regular and symlink elements, the number of directory elements, and their size fields.

pub fn digest(&self) -> B3Digest

Calculates the digest of a Directory, which is the blake3 hash of a Directory protobuf message, serialized in protobuf canonical form.

pub fn nodes( &self, ) -> impl Iterator<Item = (&PathComponent, &Node)> + Send + Sync + '_

Allows iterating over all nodes (directories, files and symlinks) For each, it returns a tuple of its name and node. The elements are sorted by their names.

pub fn into_nodes( self, ) -> impl Iterator<Item = (PathComponent, Node)> + Send + Sync

Dissolves a Directory into its individual names and nodes. The elements are sorted by their names.

pub fn add( &mut self, name: PathComponent, node: Node, ) -> Result<(), DirectoryError>

Adds the specified Node to the Directory with a given name.

Inserting a node that already exists with the same name in the directory will yield an error, as well as exceeding the maximum size.

In case you want to construct a Directory from multiple elements, use [from_iter] instead.

Trait Implementations

impl Clone for Directory

fn clone(&self) -> Directory

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Directory

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

Formats the value using the given formatter.

impl Default for Directory

fn default() -> Directory

Returns the “default value” for a type.

impl From<Directory> for Directory

fn from(value: Directory) -> Self

Converts to this type from the input type.

impl PartialEq for Directory

fn eq(&self, other: &Directory) -> 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 TryFrom<Directory> for Directory

type Error = DirectoryError

The type returned in the event of a conversion error.

fn try_from(value: Directory) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Directory

impl StructuralPartialEq for Directory