Struct Scratchpad

pub struct Scratchpad { /* private fields */ }

Scratchpad, a mutable space for encrypted data on the Network

Implementations

impl Scratchpad

pub const MAX_SIZE: usize = 4_194_304usize

Max Scratchpad size is 4MB including the metadata

pub fn new( owner: &SecretKey, data_encoding: u64, unencrypted_data: &Bytes, counter: u64, ) -> Self

Creates a new instance of Scratchpad. Encrypts the data, and signs all the elements.

pub fn new_with_signature( owner: PublicKey, data_encoding: u64, encrypted_data: Bytes, counter: u64, signature: Signature, ) -> Self

Create a new Scratchpad without provding the secret key It is the caller’s responsibility to ensure the signature is valid (signs Scratchpad::bytes_for_signature) and the data is encrypted It is recommended to use the Scratchpad::new method instead when possible

pub fn bytes_for_signature( address: ScratchpadAddress, data_encoding: u64, encrypted_data: &Bytes, counter: u64, ) -> Vec<u8>

Returns the bytes to sign for the signature

pub fn counter(&self) -> u64

Get the counter of the Scratchpad, the higher the counter, the more recent the Scratchpad is Similarly to counter CRDTs only the latest version (highest counter) of the Scratchpad is kept on the network

pub fn data_encoding(&self) -> u64

Return the current data encoding

pub fn update(&mut self, unencrypted_data: &Bytes, sk: &SecretKey)

Updates the content and encrypts it, increments the counter, re-signs the scratchpad

pub fn verify_signature(&self) -> bool

Verifies that the Scratchpad signature is valid

pub fn encrypted_data(&self) -> &Bytes

Returns the encrypted_data.

pub fn decrypt_data(&self, sk: &SecretKey) -> Result<Bytes>

Returns the encrypted_data, decrypted via the passed SecretKey

pub fn encrypted_data_hash(&self) -> XorName

Returns the encrypted_data hash

pub fn owner(&self) -> &PublicKey

Returns the owner of the scratchpad

pub fn address(&self) -> &ScratchpadAddress

Returns the address of the scratchpad

pub fn network_address(&self) -> NetworkAddress

Returns the NetworkAddress.

pub fn xorname(&self) -> XorName

Returns the xorname.

pub fn payload_size(&self) -> usize

Returns size of contained encrypted_data.

pub fn size(&self) -> usize

Size of the scratchpad

pub fn is_too_big(&self) -> bool

Returns true if the scratchpad is too big

Trait Implementations

impl Clone for Scratchpad

fn clone(&self) -> Scratchpad

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Scratchpad

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Scratchpad

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Scratchpad

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 Ord for Scratchpad

fn cmp(&self, other: &Scratchpad) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Scratchpad

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Scratchpad

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Scratchpad

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 Scratchpad

impl StructuralPartialEq for Scratchpad