Struct wildland_cargo_lib::api::user::UserApi

pub struct UserApi { /* private fields */ }

User management API

CargoUser can be created with the following methods:

• UserApi::create_user_from_entropy
• UserApi::create_user_from_mnemonic

Creating a new user means:

• checking if one does not exist yet
• generating forest identity
• generating device identity
• saving forest in CatLib
• saving forest uuid (CatLib key) in LSS
• saving forest and device identities (keypairs) in LSS

Implementations

impl UserApi

pub fn generate_mnemonic(
    &self
) -> Result<MnemonicPayload, SingleVariantError<CryptoError>>

pub fn create_mnemonic_from_vec(
    &self,
    words: Vec<String>
) -> Result<MnemonicPayload, SingleVariantError<String>>

Creates MnemonicPayload basing on a vector of words. The result may be used for creation User with UserApi::create_user_from_mnemonic.

pub fn create_user_from_entropy(
    &self,
    entropy: Vec<u8>,
    device_name: String
) -> Result<CargoUser, SingleVariantError<UserCreationError>>

pub fn create_user_from_mnemonic(
    &self,
    mnemonic: &MnemonicPayload,
    device_name: String
) -> Result<CargoUser, SingleVariantError<UserCreationError>>

pub fn get_user(&self) -> Result<CargoUser, RetrievalError<UserRetrievalError>>

Gets user if it exists

Trait Implementations

impl Clone for UserApi

fn clone(&self) -> UserApi

Returns a copy of the value.

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

Performs copy-assignment from source.