Struct routing::MutableData

pub struct MutableData { /* fields omitted */ }

Mutable data.

Methods

impl MutableData

pub fn new(     name: XorName,     tag: u64,     permissions: BTreeMap<User, PermissionSet>,     data: BTreeMap<Vec<u8>, Value>,     owners: BTreeSet<PublicKey> ) -> Result<MutableData, ClientError>

Creates a new MutableData

pub fn validate(&self) -> Result<(), ClientError>

Validate this data.

pub fn shell(&self) -> MutableData

Returns the shell of this data. Shell contains the same fields as the data itself, except the entries.

pub fn name(&self) -> &XorName

Returns the name.

pub fn tag(&self) -> u64

Returns the type tag of this MutableData

pub fn version(&self) -> u64

Returns the current version of this MutableData

pub fn owners(&self) -> &BTreeSet<PublicKey>

Returns the owner keys

pub fn get(&self, key: &[u8]) -> Option<&Value>

Returns a value by the given key

pub fn keys(&self) -> BTreeSet<&Vec<u8>>

Returns keys of all entries

pub fn values(&self) -> Vec<&Value>

Returns values of all entries

pub fn entries(&self) -> &BTreeMap<Vec<u8>, Value>

Returns all entries

pub fn take_entries(&mut self) -> BTreeMap<Vec<u8>, Value>

Removes and returns all entries

pub fn mutate_entries(     &mut self,     actions: BTreeMap<Vec<u8>, EntryAction>,     requester: PublicKey ) -> Result<(), ClientError>

Mutates entries (key + value pairs) in bulk

pub fn mutate_entries_without_validation(     &mut self,     actions: BTreeMap<Vec<u8>, EntryAction> )

Mutates entries without performing any validation.

For updates and deletes, the mutation is performed only if he entry version of the action is higher than the current version of the entry.

pub fn mutate_entry_without_validation(     &mut self,     key: Vec<u8>,     value: Value ) -> bool

Mutates single entry without performing any validations, except the version check (new version must be higher than the existing one). If the entry doesn't exist yet, inserts it, otherwise, updates it. Returns true if the version check passed and the entry was mutated, false otherwise.

pub fn permissions(&self) -> &BTreeMap<User, PermissionSet>

Gets a complete list of permissions

pub fn user_permissions(     &self,     user: &User ) -> Result<&PermissionSet, ClientError>

Gets a list of permissions for the provided user.

pub fn set_user_permissions(     &mut self,     user: User,     permissions: PermissionSet,     version: u64,     requester: PublicKey ) -> Result<(), ClientError>

Insert or update permissions for the provided user.

pub fn set_user_permissions_without_validation(     &mut self,     user: User,     permissions: PermissionSet,     version: u64 ) -> bool

Set user permission without performing any validation.

pub fn del_user_permissions(     &mut self,     user: &User,     version: u64,     requester: PublicKey ) -> Result<(), ClientError>

Delete permissions for the provided user.

pub fn del_user_permissions_without_validation(     &mut self,     user: &User,     version: u64 ) -> bool

Delete user permissions without performing any validation.

pub fn change_owner(     &mut self,     new_owner: PublicKey,     version: u64 ) -> Result<(), ClientError>

Change owner of the mutable data.

pub fn change_owner_without_validation(     &mut self,     new_owner: PublicKey,     version: u64 ) -> bool

Change the owner without performing any validation.

pub fn serialised_size(&self) -> u64

Return the size of this data after serialisation.

pub fn validate_size(&self) -> bool

Return true if the size is valid

Trait Implementations

impl Hash for MutableData

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where     H: Hasher,

Feeds a slice of this type into the given [Hasher].

impl Eq for MutableData

impl PartialEq for MutableData

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

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

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

This method tests for !=.

impl PartialOrd for MutableData

fn partial_cmp(&self, other: &MutableData) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &MutableData) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &MutableData) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &MutableData) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &MutableData) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Ord for MutableData

fn cmp(&self, other: &MutableData) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl Clone for MutableData

fn clone(&self) -> MutableData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MutableData

fn fmt(&self, formatter: &mut Formatter) -> Result

Formats the value using the given formatter.