Struct iroh_sync::sync::Entry

pub struct Entry { /* private fields */ }

A single entry in a Replica

An entry is identified by a key, its Author, and the Replica’s Namespace. Its value is the 32-byte BLAKE3 hash of the entry’s content data, the size of this content data, and a timestamp.

Implementations

impl Entry

pub fn new(id: RecordIdentifier, record: Record) -> Self

Create a new entry

pub fn new_empty(id: RecordIdentifier) -> Self

Create a new empty entry with the current timestamp.

pub fn validate_empty(&self) -> Result<(), ValidationFailure>

Validate that the entry has the empty hash if the length is 0, or a non-zero length.

pub fn id(&self) -> &RecordIdentifier

Get the RecordIdentifier for this entry.

pub fn namespace(&self) -> NamespaceId

Get the NamespaceId of this entry.

pub fn author(&self) -> AuthorId

Get the AuthorId of this entry.

pub fn key(&self) -> &[u8]

Get the key of this entry.

pub fn record(&self) -> &Record

Get the Record contained in this entry.

pub fn encode(&self, out: &mut Vec<u8>)

Serialize this entry into its canonical byte representation used for signing.

pub fn to_vec(&self) -> Vec<u8>

Serialize this entry into a new vector with its canonical byte representation.

pub fn sign(self, namespace: &Namespace, author: &Author) -> SignedEntry

Sign this entry with a Namespace and Author.

Methods from Deref<Target = Record>

pub fn is_empty(&self) -> bool

Return true if the entry is empty.

pub fn content_len(&self) -> u64

Get the length of the data addressed by this record’s content hash.

pub fn content_hash(&self) -> Hash

Get the Hash of the content data of this record.

pub fn timestamp(&self) -> u64

Get the timestamp of this record.

Trait Implementations

impl Clone for Entry

fn clone(&self) -> Entry

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Entry

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

Formats the value using the given formatter.

impl Deref for Entry

type Target = Record

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for Entry

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<SignedEntry> for Entry

fn from(value: SignedEntry) -> Self

Converts to this type from the input type.

impl Ord for Entry

fn cmp(&self, other: &Self) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Entry

fn eq(&self, other: &Entry) -> 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 Entry

fn partial_cmp(&self, other: &Self) -> 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 Entry

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 Entry

impl StructuralEq for Entry

impl StructuralPartialEq for Entry