Enum safe_nd::AData

pub enum AData {
    PubSeq(PubSeqAppendOnlyData),
    PubUnseq(PubUnseqAppendOnlyData),
    UnpubSeq(UnpubSeqAppendOnlyData),
    UnpubUnseq(UnpubUnseqAppendOnlyData),
}

Object storing an AppendOnlyData variant.

Variants

PubSeq(PubSeqAppendOnlyData)

Published sequenced AppendOnlyData.

PubUnseq(PubUnseqAppendOnlyData)

Published unsequenced AppendOnlyData.

UnpubSeq(UnpubSeqAppendOnlyData)

Unpublished sequenced AppendOnlyData.

UnpubUnseq(UnpubUnseqAppendOnlyData)

Unpublished unsequenced AppendOnlyData.

Methods

impl Data

pub fn address(&self) -> &Address

Returns the address.

pub fn kind(&self) -> Kind

Returns the kind.

pub fn name(&self) -> &XorName

Returns the name.

pub fn tag(&self) -> u64

Returns the tag.

pub fn is_pub(&self) -> bool

Returns true if published.

pub fn is_unpub(&self) -> bool

Returns true if unpublished.

pub fn is_seq(&self) -> bool

Returns true if sequenced.

pub fn is_unseq(&self) -> bool

Returns true if unsequenced.

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

Checks permissions for given action for the provided user.

Returns: Ok(()) if the permissions are valid, Err::InvalidOwners if the last owner is invalid, Err::InvalidPermissions if the requester is not the owner and the last permissions are invalid, Err::AccessDenied if the action is not allowed.

pub fn entries_index(&self) -> u64

Returns the last entry index.

pub fn permissions_index(&self) -> u64

Returns the last permissions index.

pub fn owners_index(&self) -> u64

Returns the last owners index.

pub fn in_range(&self, start: Index, end: Index) -> Option<Entries>

Gets a list of keys and values with the given indices.

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

Returns a value for the given key, if present.

pub fn indices(&self) -> Result<Indices>

Returns a tuple containing the last entries index, last owners index, and last permissions indices.

Always returns Ok(Indices).

pub fn last_entry(&self) -> Option<&Entry>

Returns the last entry, if present.

pub fn owner(&self, owners_index: impl Into<Index>) -> Option<&Owner>

Fetches owner at index.

pub fn owners_range(&self, start: Index, end: Index) -> Option<&[Owner]>

Gets a complete list of owners from the entry in the permissions list at the specified index.

pub fn append_seq(
    &mut self,
    entries: Entries,
    last_entries_index: u64
) -> Result<()>

Appends new entries.

Returns an error if duplicate entries are present or the data is not sequenced.

pub fn append_unseq(&mut self, entries: Entries) -> Result<()>

Appends new entries.

Returns an error if duplicate entries are present or the data is not unsequenced.

pub fn append_pub_permissions(
    &mut self,
    permissions: PubPermissions,
    permissions_index: u64
) -> Result<()>

Adds a new published permissions entry for published data. The Perm struct should contain valid indices.

If the specified permissions_index does not match the last recorded permissions index + 1 or if this data is not published, an error will be returned.

pub fn append_unpub_permissions(
    &mut self,
    permissions: UnpubPermissions,
    permissions_index: u64
) -> Result<()>

Adds a new unpublished permissions entry for unpublished data. The Perm struct should contain valid indices.

If the specified permissions_index does not match the last recorded permissions index + 1 or if this data is not unpublished, an error will be returned.

pub fn append_owner(&mut self, owner: Owner, owners_index: u64) -> Result<()>

Adds a new owner entry.

If the specified owners_index does not match the last recorded owners index + 1, an error will be returned.

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

Checks if the requester is the last owner.

Returns: Ok(()) if the requester is the owner, Err::InvalidOwners if the last owner is invalid, Err::AccessDenied if the requester is not the owner.

pub fn pub_user_permissions(
    &self,
    user: User,
    index: impl Into<Index>
) -> Result<PubPermissionSet>

Returns published user permissions, if applicable.

pub fn unpub_user_permissions(
    &self,
    user: PublicKey,
    index: impl Into<Index>
) -> Result<UnpubPermissionSet>

Returns unpublished user permissions, if applicable.

pub fn pub_permissions(
    &self,
    index: impl Into<Index>
) -> Result<&PubPermissions>

Returns published permissions, if applicable.

pub fn unpub_permissions(
    &self,
    index: impl Into<Index>
) -> Result<&UnpubPermissions>

Returns unpublished permissions, if applicable.

pub fn shell(&self, index: impl Into<Index>) -> Result<Self>

Returns the shell of the data.

Trait Implementations

impl Clone for Data

fn clone(&self) -> Data

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Ord for Data

fn cmp(&self, other: &Data) -> 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.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl From<Data> for Data

fn from(data: AData) -> Self

Performs the conversion.

impl PartialOrd<Data> for Data

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

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

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

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

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

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

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

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

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

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

impl PartialEq<Data> for Data

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

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

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

This method tests for !=.

impl Eq for Data

impl Debug for Data

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

Formats the value using the given formatter.

impl Hash for Data

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 TryFrom<Response> for AData

type Error = TryFromError

The type returned in the event of a conversion error.

fn try_from(response: Response) -> Result<Self, Self::Error>

Performs the conversion.

impl Serialize for Data

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Data

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

Deserialize this value from the given Serde deserializer.