Struct wildland_catlib::CatLib

pub struct CatLib { /* private fields */ }

Implementations

impl CatLib

pub fn new(path: PathBuf) -> Self

pub fn create_forest(
    &self,
    owner: Identity,
    signers: Signers,
    data: Vec<u8>
) -> CatlibResult<Forest>

Create new Forest obect.

owner and signers are cryptographical objects that are used by the Core module to verify the cryptographical integrity of the manifests.

data is an arbitrary data object that can be used to synchronize Forest state between devices.

Errors

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

Example

let forest_owner = Identity([1; 32]);
let signer = Identity([2; 32]);

let catlib = CatLib::default();
let forest = catlib.create_forest(
                 forest_owner,
                 HashSet::from([signer]),
                 vec![],
             ).unwrap();

pub fn get_forest(&self, uuid: Uuid) -> CatlibResult<Forest>

Return Forest object by Forest UUID.

pub fn find_forest(&self, owner: Identity) -> CatlibResult<Forest>

Return Forest owned by specified owner.

Note: by design each owner may have only one Forest

Errors

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

pub fn get_container(&self, uuid: Uuid) -> CatlibResult<Container>

Return Container object by Container UUID.

pub fn find_storages_with_template(
    &self,
    template_id: Uuid
) -> CatlibResult<Vec<Storage>>

Return Storages that were created using given template_id UUID.

Errors

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

pub fn find_containers_with_template(
    &self,
    template_id: Uuid
) -> CatlibResult<Vec<Container>>

Return Containers that were created using given template_id UUID.

Errors

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

Trait Implementations

impl Clone for CatLib

fn clone(&self) -> CatLib

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for CatLib

fn default() -> Self

Returns the “default value” for a type.