Struct identity_iota::account::AccountBuilder

pub struct AccountBuilder<C = Arc<Client>> where
    C: SharedPtr<Client>,  { /* private fields */ }

Available on crate feature account only.

An Account builder for easy account configuration.

To reduce memory usage, accounts created from the same builder share the same Storage used to store identities, and the same Client used to publish identities to the Tangle.

The configuration on the other hand is cloned, and therefore unique for each built account. This means a builder can be reconfigured in-between account creations, without affecting the configuration of previously built accounts.

Implementations

impl<C> AccountBuilder<C> where
    C: SharedPtr<Client>, 

pub fn new() -> AccountBuilder<C>

Creates a new AccountBuilder.

pub fn autosave(self, value: AutoSave) -> AccountBuilder<C>

Sets the account auto-save behaviour.

pub fn autopublish(self, value: bool) -> AccountBuilder<C>

Sets the account auto-publish behaviour.

pub fn storage<S>(self, value: S) -> AccountBuilder<C> where
    S: 'static + Storage, 

Sets the account storage adapter.

pub fn storage_shared(
    self,
    value: Arc<dyn Storage + 'static>
) -> AccountBuilder<C>

Sets the account storage adapter from a shared pointer.

pub fn client(self, client: C) -> AccountBuilder<C>

Sets the IOTA Tangle Client, this determines the Network used by the identity. Accounts created by the same AccountBuilder will share the same Client.

NOTE: this overwrites any ClientBuilder previously set by AccountBuilder::client_builder.

pub fn client_builder(self, client_builder: ClientBuilder) -> AccountBuilder<C>

Sets the IOTA Tangle Client, this determines the Network used by the identity. Accounts created by the same AccountBuilder will share the same Client.

NOTE: this overwrites any Client previously set by AccountBuilder::client.

pub async fn create_identity(
    &mut self,
    input: IdentitySetup
) -> Result<Account<C>, Error>

Creates a new identity based on the builder configuration and returns an Account instance to manage it.

The identity is stored locally in the Storage. The DID network is automatically determined by the Client used to publish it.

See IdentitySetup to customize the identity creation.

pub async fn load_identity(&mut self, did: IotaDID) -> Result<Account<C>, Error>

Loads an existing identity with the specified did using the current builder configuration. The identity must exist in the configured Storage.

Warning

Callers are expected not to load the same IotaDID into more than one account, as that would cause race conditions when updating the identity.

Trait Implementations

impl<C> Debug for AccountBuilder<C> where
    C: Debug + SharedPtr<Client>, 

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

Formats the value using the given formatter.

impl<C> Default for AccountBuilder<C> where
    C: SharedPtr<Client>, 

fn default() -> AccountBuilder<C>

Returns the “default value” for a type.