Struct sn_data_types::SeqMap

pub struct SeqMap { /* fields omitted */ }

Map that is unpublished on the network. This data can only be fetched by the owner or those in the permissions fields with Permission::Read access.

Implementations

impl SeqData

pub fn address(&self) -> &Address

Returns the address.

pub fn name(&self) -> &XorName

Returns the name.

pub fn tag(&self) -> u64

Returns the tag type.

pub fn kind(&self) -> Kind

Returns the kind.

pub fn version(&self) -> u64

Returns the version of the Map fields (not the data version).

pub fn owner(&self) -> &PublicKey

Returns the owner key.

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

Returns all the keys in the data.

pub fn shell(&self) -> Self

Returns the shell of this Map (the fields without the data).

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

Gets a complete list of permissions.

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

Gets the permissions for the provided user.

pub fn check_is_owner(&self, requester: PublicKey) -> Result<()>

Checks if the provided user is an owner.

Returns Ok(()) on success and Err(Error::AccessDenied) if the user is not an owner.

pub fn check_permissions(
    &self,
    action: Action,
    requester: PublicKey
) -> Result<()>

Checks permissions for given action for the provided user.

Returns Err(Error::AccessDenied) if the permission check has failed.

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

Inserts or updates permissions for the provided user.

Requires the new version of the Map fields. If it does not match the current version + 1, an error will be returned.

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

Deletes permissions for the provided user.

Requires the new version of the Map fields. If it does not match the current version + 1, an error will be returned.

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

Deletes user permissions without performing any validation.

Requires the new version of the Map fields. If it does not match the current version + 1, an error will be returned.

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

Changes the owner.

Requires the new version of the Map fields. If it does not match the current version + 1, an error will be returned.

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

Changes the owner without performing any validation.

Requires the new version of the Map fields. If it does not match the current version + 1, an error will be returned.

pub fn is_action_allowed(&self, requester: &PublicKey, action: Action) -> bool

Returns true if action is allowed for the provided user.

impl SeqData

Implements functions for sequenced Map.

pub fn new(name: XorName, tag: u64, owner: PublicKey) -> Self

Creates a new sequenced Map.

pub fn new_with_data(
    name: XorName,
    tag: u64,
    data: SeqEntries,
    permissions: BTreeMap<PublicKey, PermissionSet>,
    owner: PublicKey
) -> Self

Creates a new sequenced Map with entries and permissions.

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

Returns a value by the given key

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

Returns values of all entries

pub fn entries(&self) -> &SeqEntries

Returns all entries

pub fn take_entries(&mut self) -> SeqEntries

Removes and returns all entries

pub fn mutate_entries(
    &mut self,
    actions: SeqEntryActions,
    requester: PublicKey
) -> Result<()>

Mutates entries (key + value pairs) in bulk.

Returns Err(InvalidEntryActions) if the mutation parameters are invalid.

Trait Implementations

impl Clone for SeqData

fn clone(&self) -> SeqData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SeqData

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SeqData

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

Deserialize this value from the given Serde deserializer.

impl Eq for SeqData

impl From<SeqData> for Data

fn from(data: SeqData) -> Self

Performs the conversion.

impl Hash for SeqData

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 Ord for SeqData

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

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<SeqData> for SeqData

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

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

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

This method tests for !=.

impl PartialOrd<SeqData> for SeqData

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

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

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

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

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

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

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

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

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

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

impl Serialize for SeqData

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 SeqData

impl StructuralPartialEq for SeqData