Struct sn_data_types::Sequence

pub struct Sequence { /* fields omitted */ }

Object storing the Sequence

Implementations

impl Data

pub fn new_public(
    authority: PublicKey,
    actor: String,
    name: XorName,
    tag: u64,
    policy: Option<PublicPolicy>
) -> Self

Constructs a new Public Sequence Data. The ‘authority’ is assumed to be the PK which the messages were and will be signed with, whilst the ‘actor’ is a unique identifier to be used as the clock’s Dot in all operations generated by this instance. If a policy is not provided, a default policy will be set where the ‘authority’ is the owner along with an empty users permissions set.

pub fn new_private(
    authority: PublicKey,
    actor: String,
    name: XorName,
    tag: u64,
    policy: Option<PrivatePolicy>
) -> Self

Constructs a new Private Sequence Data. The ‘authority’ is assumed to be the PK which the messages were and will be signed with, whilst the ‘actor’ is a unique identifier to be used as the clock’s Dot in all operations generated by this instance. If a policy is not provided, a default policy will be set where the ‘authority’ is the owner along with an empty users permissions set.

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_public(&self) -> bool

Returns true if public.

pub fn is_private(&self) -> bool

Returns true if private.

pub fn len(&self, requester: Option<PublicKey>) -> Result<u64>

Returns the length of the sequence, optionally verifying read permissions if a pk is provided

pub fn is_empty(&self, requester: Option<PublicKey>) -> Result<bool>

Returns true if the sequence is empty.

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

Gets a list of items which are within the given indices. Note the range of items is [start, end), i.e. the end index is not inclusive.

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

Returns a value at ‘index’, if present.

pub fn last_entry(&self, requester: Option<PublicKey>) -> Result<Option<&Entry>>

Returns the last entry, if it’s not empty.

pub fn create_unsigned_append_op(
    &mut self,
    entry: Entry
) -> Result<DataOp<Entry>>

Generate unsigned crdt op, adding the new entry.

pub fn apply_op(&mut self, op: DataOp<Entry>) -> Result<()>

Apply a signed data CRDT operation.

pub fn permissions(
    &self,
    user: User,
    requester: Option<PublicKey>
) -> Result<Permissions>

Returns user permissions, if applicable.

pub fn public_policy(&self) -> Result<&PublicPolicy>

Returns the public policy, if applicable.

pub fn private_policy(
    &self,
    requester: Option<PublicKey>
) -> Result<&PrivatePolicy>

Returns the private policy, if applicable.

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

Helper to check permissions for given action for the given requester’s public key.

Returns: Ok(()) if the permissions are valid, Err::AccessDenied if the action is not allowed.

pub fn owner(&self) -> PublicKey

Returns the owner of the data.

pub fn replica_authority(&self) -> PublicKey

Returns the PK which the messages are expected to be signed with by this replica.

Trait Implementations

impl Clone for Data

fn clone(&self) -> Data

Returns a copy of the value.

pub 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.

pub 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.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn ge(&self, other: &Rhs) -> 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