Struct rubbish::fs::Tree

pub struct Tree { /* fields omitted */ }

A Tree represents an image of a tree-shaped data structure, sort of like a filesystem directoy. However, directories can have associated data (that is, there can be data at foo/bar and at foo/bar/bing).

Methods

impl Tree

fn for_root(root: Hash) -> Tree

Create a new tree with the given root hash

fn empty() -> Tree

Create a new, empty tree

fn store(&self, storage: &mut ObjectStorage) -> Hash

Store this tree into the given storage, returning its hash.

fn write(
    self,
    storage: &ObjectStorage,
    path: &[&str],
    data: String
) -> Result<Tree, String>

Return a tree containing new value at the designated path, replacing any existing value at that path. The storage is used to read any unresolved tree nodes, but nothing is written to storage.

Note that path elements and data can coexist, unlike a UNIX filesystem; that is, writing a value to "usr/bin" will not invalidate paths like "usr/bin/rustc".

Writing uses path copying to copy a minimal amount of tree data such that the original tree is not modified and a new tree is returned, sharing data where possible.

fn remove(self, storage: &ObjectStorage, path: &[&str]) -> Result<Tree, String>

Return a tree with the value at the given path removed. Empty directories will be removed. The storage is used to read any unresolvedtree nodes, but nothing is written to storage. If the path is already missing, an unchanged copy of the tree is returned.

This operation uses path copying to copy a minimal amount of tree data such that the original tree is not modified and a new tree is returned, sharing data where possible.

fn read(&self, storage: &ObjectStorage, path: &[&str]) -> Result<String, String>

Read the value at the given path in this tree, returning an error if this fails. If no value is set at the given path, that is considered an error.

Trait Implementations

impl Clone for Tree

fn clone(&self) -> Tree

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Tree

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.