Enum sn_data_types::Sequence

pub enum Sequence {
    Public(PublicSeqData),
    Private(PrivateSeqData),
}

Object storing a Sequence variant.

Variants

Public(PublicSeqData)

Public Sequence Data.

Private(PrivateSeqData)

Private Sequence Data.

Implementations

impl Data

pub fn new_public(actor: PublicKey, name: XorName, tag: u64) -> Self

Constructs a new Public Sequence Data.

pub fn new_private(actor: PublicKey, name: XorName, tag: u64) -> Self

Constructs a new Private Sequence 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 public.

pub fn is_private(&self) -> bool

Returns true if private.

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::AccessDenied if the action is not allowed.

pub fn len(&self) -> u64

Returns the length of the sequence.

pub fn is_empty(&self) -> bool

Returns true if the sequence is empty.

pub fn policy_version(&self) -> u64

Returns the version of last Policy.

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

Gets a list of items which are within the given indices.

pub fn get(&self, index: Index) -> Option<&Vec<u8>>

Returns a value at 'index', if present.

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

Returns the last entry, if present.

pub fn append(&mut self, entry: Entry) -> Result<DataWriteOp<Entry>>

Appends new entry.

pub fn apply_data_op(&mut self, op: DataWriteOp<Entry>) -> Result<()>

Apply a data CRDT operation.

pub fn set_pub_policy(
    &mut self,
    owner: PublicKey,
    permissions: BTreeMap<User, PublicPermissions>
) -> Result<PolicyWriteOp<PublicPolicy>>

Sets the new policy for Public Sequence.

pub fn set_priv_policy(
    &mut self,
    owner: PublicKey,
    permissions: BTreeMap<PublicKey, PrivatePermissions>
) -> Result<PolicyWriteOp<PrivatePolicy>>

Sets the new policy for Private Sequence.

pub fn apply_pub_policy_op(
    &mut self,
    op: PolicyWriteOp<PublicPolicy>
) -> Result<()>

Apply Public Policy CRDT operation.

pub fn apply_priv_policy_op(
    &mut self,
    op: PolicyWriteOp<PrivatePolicy>
) -> Result<()>

Apply Private Policy CRDT operation.

pub fn permissions(
    &self,
    user: User,
    version: impl Into<Index>
) -> Result<Permissions>

Returns user permissions, if applicable.

pub fn pub_policy(&self, version: impl Into<Index>) -> Result<&PublicPolicy>

Returns public policy, if applicable.

pub fn priv_policy(&self, version: impl Into<Index>) -> Result<&PrivatePolicy>

Returns private policy, if applicable.

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 Debug for Data

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

Formats the value using the given formatter.

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.

impl Eq for Data

impl From<Data> for Data

fn from(data: Sequence) -> Self

Performs the conversion.

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 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 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 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 StructuralEq for Data

impl StructuralPartialEq for Data

impl TryFrom<QueryResponse> for Sequence

type Error = TryFromError

The type returned in the event of a conversion error.

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

Performs the conversion.