Struct safe_network::types::register::Register

pub struct Register { /* private fields */ }

Object storing the Register

Implementations

impl Register

pub fn new(name: XorName, tag: u64, policy: Policy, cap: u16) -> Self

pub fn new_public(
    authority: User,
    name: XorName,
    tag: u64,
    policy: Option<PublicPolicy>,
    cap: u16
) -> Self

Construct a new Public Register. The ‘authority’ is assumed to be the PK which the messages were and will be signed with. 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: User,
    name: XorName,
    tag: u64,
    policy: Option<PrivatePolicy>,
    cap: u16
) -> Self

Construct a new Private Register. The ‘authority’ is assumed to be the PK which the messages were and will be signed with. 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 is_public(&self) -> bool

Return true if public.

pub fn is_private(&self) -> bool

Return true if private.

pub fn address(&self) -> &Address

Return the address.

pub fn scope(&self) -> Scope

Return the scope.

pub fn name(&self) -> &XorName

Return the name.

pub fn tag(&self) -> u64

Return the tag.

pub fn owner(&self) -> User

Return the owner of the data.

pub fn replica_authority(&self) -> User

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

pub fn cap(&self) -> u16

Return the max number of items that can be held in the register.

pub fn size(&self) -> u64

Return the number of items held in the register

pub fn is_empty(&self) -> bool

Return true if the register is empty.

pub fn get(&self, hash: EntryHash) -> Result<&Entry>

Return a value corresponding to the provided ‘hash’, if present.

pub fn read(&self) -> BTreeSet<(EntryHash, Entry)>

Read the last entry, or entries when there are branches, if the register is not empty.

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

Return user permissions, if applicable.

pub fn policy(&self) -> &Policy

Return the policy.

pub fn increment_cap(&mut self, add: u16)

Increment the size cap of the register, returning the previous value.

pub fn write(
    &mut self,
    entry: Entry,
    children: BTreeSet<EntryHash>
) -> Result<(EntryHash, RegisterOp<Entry>)>

Write an entry to the Register, returning the generated unsigned CRDT operation so the caller can sign and broadcast it to other replicas, along with the hash of the entry just written.

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

Apply a signed data CRDT operation.

pub fn check_permissions(
    &self,
    action: Action,
    requester: Option<User>
) -> 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.

Trait Implementations

impl Clone for Register

fn clone(&self) -> Register

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Register

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Register

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

Deserialize this value from the given Serde deserializer.

impl Hash for Register

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<Register> for Register

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

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

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

This method tests for !=.

impl PartialOrd<Register> for Register

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

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

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

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

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

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

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

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

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 Register

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

Serialize this value into the given Serde serializer.

impl TryFrom<QueryResponse> for Register

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.

impl Eq for Register

impl StructuralEq for Register

impl StructuralPartialEq for Register