Trait wildland_catlib::contracts::IForest

pub trait IForest {
    fn uuid(&self) -> Uuid;
    fn owner(&self) -> Identity;
    fn signers(&self) -> Signers;
    fn data(&self) -> Vec<u8>;
    fn add_signer(&mut self, signer: Identity) -> CatlibResult<bool>;
    fn del_signer(&mut self, signer: Identity) -> CatlibResult<bool>;
    fn containers(&self) -> CatlibResult<Vec<Container>>;
    fn update(&mut self, data: Vec<u8>) -> CatlibResult<()>;
    fn remove(&mut self) -> CatlibResult<bool>;
    fn create_container(&self) -> CatlibResult<Container>;
    fn create_bridge(
        &self,
        path: ContainerPath,
        link_data: Vec<u8>
    ) -> CatlibResult<Bridge>;
    fn find_bridge(&self, path: ContainerPath) -> CatlibResult<Bridge>;
    fn find_containers(
        &self,
        paths: Vec<ContainerPath>,
        include_subdirs: bool
    ) -> CatlibResult<Vec<Container>>;
}

Required Methods

fn uuid(&self) -> Uuid

Return UUID object identifier

fn owner(&self) -> Identity

Return Forest owner

fn signers(&self) -> Signers

Return list of manifests Signers

fn data(&self) -> Vec<u8>

Return Forest arbitrary data

fn add_signer(&mut self, signer: Identity) -> CatlibResult<bool>

Add manifest Signer

Returns whether the value was newly inserted. That is:

• If the signer did not previously exist, true is returned.
• If the signer already exists, false is returned.

Errors

Returns RustbreakError cast on CatlibResult upon failure to save to the database.

fn del_signer(&mut self, signer: Identity) -> CatlibResult<bool>

Delete manifest Signer

Returns whether the value was already present. That is:

• If the signer did not previously exist, false is returned.
• If the signer existed in the set, true is returned.

Errors

Returns RustbreakError cast on CatlibResult upon failure to save to the database.

fn containers(&self) -> CatlibResult<Vec<Container>>

Return list of Forest Containers

Errors

Returns CatlibError::NoRecordsFound if Forest has no Container.

fn update(&mut self, data: Vec<u8>) -> CatlibResult<()>

Set Forest arbitrary data

Errors

Returns RustbreakError cast on CatlibResult upon failure to save to the database.

fn remove(&mut self) -> CatlibResult<bool>

Delete Forest from the database

WARN: The underlying objects are not removed recursively

Errors

Returns RustbreakError cast on CatlibResult upon failure to save to the database.

fn create_container(&self) -> CatlibResult<Container>

Create an empty container, bound to the Forest.

To set container paths, use Container::add_path

Errors

Returns RustbreakError cast on CatlibResult upon failure to save to the database.

Example

let catlib = CatLib::default();
let forest = catlib.create_forest(
                 Identity([1; 32]),
                 HashSet::from([Identity([2; 32])]),
                 vec![],
             ).unwrap();
let mut container = forest.create_container().unwrap();
container.add_path("/foo/bar".to_string());
container.add_path("/bar/baz".to_string());

fn create_bridge(
    &self,
    path: ContainerPath,
    link_data: Vec<u8>
) -> CatlibResult<Bridge>

Create a Bridge obect with arbitrary link data to another Forest.

The aforementioned link data will be defined by the D/FS module.

Errors

Returns RustbreakError cast on CatlibResult upon failure to save to the database.

Example

let catlib = CatLib::default();
let forest = catlib.create_forest(
                 Identity([1; 32]),
                 HashSet::from([Identity([2; 32])]),
                 vec![],
             ).unwrap();
forest.create_bridge("/other/forest".to_string(), vec![]);

fn find_bridge(&self, path: ContainerPath) -> CatlibResult<Bridge>

Return bridge that matches the given ContainerPath.

Errors

• Returns CatlibError::NoRecordsFound if no Bridge was found.
• Returns CatlibError::MalformedDatabaseEntry if more than one Bridge was found.

fn find_containers(
    &self,
    paths: Vec<ContainerPath>,
    include_subdirs: bool
) -> CatlibResult<Vec<Container>>

Retrieve Containers that match given ContainerPaths.

If include_subdirs is true, then the ContainerPaths are treated as Path prefixes and not absolute paths.

Errors

• Returns CatlibError::NoRecordsFound if no Container was found.

Example

use wildland_catlib::CatLib;

use std::collections::HashSet;

use crate::wildland_catlib::*;

let catlib = CatLib::default(); let forest = catlib.create_forest( b“owner“.to_vec(), HashSet::from([b“signer“.to_vec()]), vec![], ).unwrap(); let mut container = forest.create_container().unwrap(); container.add_path(“/foo/bar”.to_string());

let containers = forest.find_containers(vec![“/foo/bar”.to_string()], false).unwrap();

Implementors

impl IForest for Forest