Struct sn_client::client::map_info::MapInfo

pub struct MapInfo {
    pub address: MapAddress,
    pub enc_info: Option<(Key, SymEncNonce)>,
    pub new_enc_info: Option<(Key, SymEncNonce)>,
}

Information allowing to locate and access mutable data on the network.

Fields

address: MapAddress

Address of the mutable data, containing its name, type tag, and whether it is sequenced.

enc_info: Option<(Key, SymEncNonce)>

Key to encrypt/decrypt the directory content and the nonce to be used for keys

new_enc_info: Option<(Key, SymEncNonce)>

Future encryption info, used for two-phase data reencryption.

Implementations

impl MapInfo

pub fn new_private(address: MapAddress, enc_info: (Key, SymEncNonce)) -> Self

Construct MapInfo for private (encrypted) data with a provided private key.

pub fn new_public(address: MapAddress) -> Self

Construct MapInfo for public data.

pub fn random_private(kind: MapKind, type_tag: u64) -> Result<Self, Error>

Generate random MapInfo for private (encrypted) mutable data.

pub fn random_public(kind: MapKind, type_tag: u64) -> Result<Self, Error>

Generate random MapInfo for public mutable data.

pub fn name(&self) -> XorName

Returns the name.

pub fn type_tag(&self) -> u64

Returns the type tag.

pub fn address(&self) -> &MapAddress

Returns the address of the data.

pub fn kind(&self) -> MapKind

Returns the kind.

pub fn enc_key(&self) -> Option<&Key>

Returns the encryption key, if any.

pub fn nonce(&self) -> Option<&SymEncNonce>

Returns the nonce, if any.

pub fn enc_entry_key(&self, plain_text: &[u8]) -> Result<Vec<u8>, Error>

Encrypt the key for the map entry accordingly.

pub fn enc_entry_value(&self, plain_text: &[u8]) -> Result<Vec<u8>, Error>

Encrypt the value for this map entry accordingly.

pub fn decrypt(&self, cipher: &[u8]) -> Result<Vec<u8>, Error>

Decrypt key or value of this map entry.

pub fn start_new_enc_info(&mut self)

Start the encryption info re-generation by populating the new_enc_info field with random keys, unless it's already populated.

pub fn commit_new_enc_info(&mut self)

Commit the encryption info re-generation by replacing the current encryption info with new_enc_info (if any).

Trait Implementations

impl Clone for MapInfo

fn clone(&self) -> MapInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MapInfo

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MapInfo

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for MapInfo

impl PartialEq<MapInfo> for MapInfo

fn eq(&self, other: &MapInfo) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &MapInfo) -> bool

This method tests for !=.

impl Serialize for MapInfo

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

Serialize this value into the given Serde serializer.

impl StructuralEq for MapInfo

impl StructuralPartialEq for MapInfo