Enum iota_stronghold::types::Location

pub enum Location {
    Generic {
        vault_path: Vec<u8>,
        record_path: Vec<u8>,
    },
    Counter {
        vault_path: Vec<u8>,
        counter: usize,
    },
}

A Location type used to specify where in the Stronghold a piece of data should be stored. A generic location specifies a non-versioned location while a counter location specifies a versioned location. The Counter location can be used to get the head of the version chain by passing in None as the counter index. Otherwise, counter records are referenced through their associated index. On Read, the None location is the latest record in the version chain while on Write, the None location is the next record in the version chain.

Note: For each used vault an encryption key is created and protected through the libsodium memory protection API. Many systems place limits on the amount of memory that may be locked by a process, which may result in the system panicking if the upper bound is reached! For users that write a large number of secrets into Stronghold, we strongly advise against writing each record in a separate vault, but instead group them into a limited number of different vaults.

Variants

Generic

Fields

vault_path: Vec<u8>

record_path: Vec<u8>

Counter

Fields

vault_path: Vec<u8>

counter: usize

Implementations

impl Location

pub fn vault_path(&self) -> &[u8]

Gets the vault_path from the Location.

pub fn record_path(&self) -> &[u8]

Returns the record_path from the Location. If the Location type is Self::Counter, the vault_path will be returned.

pub fn generic<V: Into<Vec<u8>>, R: Into<Vec<u8>>>( vault_path: V, record_path: R ) -> Self

Creates a generic location from types that implement Into<Vec<u8>>.

pub fn counter<V: Into<Vec<u8>>, C: Into<usize>>( vault_path: V, counter: C ) -> Self

Creates a counter location from a type that implements Into<Vec<u8>> and a counter type that implements Into<usize>

pub const fn const_generic(vault_path: Vec<u8>, record_path: Vec<u8>) -> Self

Used to generate a constant generic location.

pub const fn const_counter(vault_path: Vec<u8>, counter: usize) -> Self

used to generate a constant counter location.

pub fn resolve(&self) -> (VaultId, RecordId)

Resolves itself into VaultId and RecordId

Trait Implementations

impl AsRef<Location> for Location

fn as_ref(&self) -> &Location

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Location

fn clone(&self) -> Location

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Location

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Location

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Location

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.