Struct TreeBuilder 

pub struct TreeBuilder { /* private fields */ }

An in-memory, programmatic source: add entries, then hand it to the model.

Order of addition does not affect the result — the model sorts by path so the inode numbering is deterministic — but a directory’s contents are only valid if the directory itself is also added.

Implementations

impl TreeBuilder

pub fn new() -> Self

A builder with no entries. The root directory always exists implicitly and is not added here.

pub fn directory(self, path: impl Into<Vec<u8>>, meta: Metadata) -> Self

Add a directory at path.

pub fn root(self, meta: Metadata) -> Self

Set the root directory’s own metadata, overriding the 0755 root-owned default.

The root already exists, so this describes it rather than adding an entry; any xattr that follows attaches to the root. Naming it once is enough — a second root entry is a duplicate the model rejects.

pub fn file( self, path: impl Into<Vec<u8>>, contents: impl Into<FileContent>, meta: Metadata, ) -> Self

Add a regular file at path with contents.

contents is anything that converts into a FileContent: an owned Vec<u8> or String, a borrowed &[u8], &[u8; N], or &str — each copied into the entry — or a FileRange, which names bytes on the host and reads them when the file is placed rather than now.

pub fn symlink( self, path: impl Into<Vec<u8>>, target: impl Into<Vec<u8>>, meta: Metadata, ) -> Self

Add a symbolic link at path pointing at target.

pub fn hardlink( self, path: impl Into<Vec<u8>>, target: impl Into<Vec<u8>>, meta: Metadata, ) -> Self

Add a hard link at path to the entry already declared at target, which may be of any kind but a directory, and may itself be a hard link.

The link shares the target’s inode, so the two names are one file: the metadata, extended attributes, and contents are the inode’s, and the meta given here is not applied.

pub fn char_device( self, path: impl Into<Vec<u8>>, major: u32, minor: u32, meta: Metadata, ) -> Self

Add a character-special device node at path.

pub fn block_device( self, path: impl Into<Vec<u8>>, major: u32, minor: u32, meta: Metadata, ) -> Self

Add a block-special device node at path.

pub fn fifo(self, path: impl Into<Vec<u8>>, meta: Metadata) -> Self

Add a named pipe (FIFO) at path.

pub fn socket(self, path: impl Into<Vec<u8>>, meta: Metadata) -> Self

Add a Unix-domain socket node at path.

pub fn xattr(self, name: impl Into<Vec<u8>>, value: impl Into<Vec<u8>>) -> Self

Attach an extended attribute to the most recently added entry.

name is the fully-qualified attribute name (e.g. b"security.capability"). If no entry has been added yet, the call has no effect.

Trait Implementations

impl Clone for TreeBuilder

fn clone(&self) -> TreeBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TreeBuilder

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

Formats the value using the given formatter.

impl Default for TreeBuilder

fn default() -> TreeBuilder

Returns the “default value” for a type.

impl Source for TreeBuilder

fn into_entries(self) -> Vec<SourceEntry>

Produce the entries, consuming the source.