Struct sn_registers::Register
source · pub struct Register { /* private fields */ }
Expand description
A Register on the SAFE Network
Implementations§
source§impl Register
impl Register
sourcepub fn new(owner: PublicKey, meta: XorName, permissions: Permissions) -> Self
pub fn new(owner: PublicKey, meta: XorName, permissions: Permissions) -> Self
Create a new Register
sourcepub fn sign(&self, secret_key: &SecretKey) -> Result<Signature, Error>
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
sourcepub fn bytes(&self) -> Result<Vec<u8>, Error>
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
sourcepub fn into_signed(
self,
secret_key: &SecretKey
) -> Result<SignedRegister, Error>
pub fn into_signed( self, secret_key: &SecretKey ) -> Result<SignedRegister, Error>
Sign a Register into a SignedRegister
sourcepub fn address(&self) -> &RegisterAddress
pub fn address(&self) -> &RegisterAddress
Return the address.
sourcepub fn get(&self, hash: EntryHash) -> Result<&Entry, Error>
pub fn get(&self, hash: EntryHash) -> Result<&Entry, Error>
Return a value corresponding to the provided ‘hash’, if present.
sourcepub fn read(&self) -> BTreeSet<(EntryHash, Entry)>
pub fn read(&self) -> BTreeSet<(EntryHash, Entry)>
Read the last entry, or entries when there are branches, if the register is not empty.
sourcepub fn children(&self, hash: &EntryHash) -> BTreeSet<(EntryHash, Entry)>
pub fn children(&self, hash: &EntryHash) -> BTreeSet<(EntryHash, Entry)>
Returns the children of an entry, along with their corresponding entry hashes
sourcepub fn permissions(&self) -> &Permissions
pub fn permissions(&self) -> &Permissions
Return the permission.
sourcepub fn write(
&mut self,
entry: Entry,
children: &BTreeSet<EntryHash>,
signer: &SecretKey
) -> Result<(EntryHash, RegisterOp), Error>
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.
sourcepub fn apply_op(&mut self, op: RegisterOp) -> Result<(), Error>
pub fn apply_op(&mut self, op: RegisterOp) -> Result<(), Error>
Apply a signed data CRDT operation.
sourcepub fn merge(&mut self, other: &Self) -> Result<(), Error>
pub fn merge(&mut self, other: &Self) -> Result<(), Error>
Merge another Register into this one.
sourcepub fn check_register_op(&self, op: &RegisterOp) -> Result<(), Error>
pub fn check_register_op(&self, op: &RegisterOp) -> Result<(), Error>
Check if a register op is valid for our current register
sourcepub fn check_user_permissions(&self, requester: PublicKey) -> Result<(), Error>
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
sourcepub fn merkle_reg(&self) -> &MerkleReg<Entry>
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§
source§impl<'de> Deserialize<'de> for Register
impl<'de> Deserialize<'de> for Register
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
source§impl PartialEq for Register
impl PartialEq for Register
source§impl PartialOrd for Register
impl PartialOrd for Register
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moreimpl Eq for Register
impl StructuralPartialEq for Register
Auto Trait Implementations§
impl Freeze for Register
impl RefUnwindSafe for Register
impl Send for Register
impl Sync for Register
impl Unpin for Register
impl UnwindSafe for Register
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> FmtForward for T
impl<T> FmtForward for T
source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moresource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moresource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> R
source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.source§impl<T> Tap for T
impl<T> Tap for T
source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read moresource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read moresource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read moresource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read moresource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read moresource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read moresource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.