Struct sn_registers::Register

pub struct Register { /* private fields */ }

A Register on the SAFE Network

Implementations

impl Register

pub fn new(owner: PublicKey, meta: XorName, permissions: Permissions) -> Self

Create a new Register

pub fn sign(&self, secret_key: &SecretKey) -> Result<Signature, Error>

Sign a Register and return the signature, makes sure the signer is the owner in the process

pub fn bytes(&self) -> Result<Vec<u8>, Error>

Returns a bytes version of the Register used for signing Use this API when you want to sign a Register withtout providing a secret key to the Register API

pub fn into_signed( self, secret_key: &SecretKey ) -> Result<SignedRegister, Error>

Sign a Register into a SignedRegister

pub fn address(&self) -> &RegisterAddress

Return the address.

pub fn owner(&self) -> PublicKey

Return the owner of the data.

pub fn size(&self) -> u64

Return the number of items held in the register

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

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) -> &Permissions

Return the permission.

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

Write an entry to the Register, returning the generated 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) -> Result<(), Error>

Apply a signed data CRDT operation.

pub fn merge(&mut self, other: &Self) -> Result<(), Error>

Merge another Register into this one.

pub fn check_register_op(&self, op: &RegisterOp) -> Result<(), Error>

Check if a register op is valid for our current register

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

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

Returns: Ok(()) if the user can write to this register Err::AccessDenied if the user cannot write to this register

pub fn merkle_reg(&self) -> &MerkleReg<Entry>

Access the underlying MerkleReg (e.g. for access to history) NOTE: This API is unstable and may be removed in the future

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq 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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd 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 Eq for Register

impl StructuralPartialEq for Register