Struct iroh_docs::sync::SignedEntry

pub struct SignedEntry { /* private fields */ }

A signed entry.

Implementations

impl SignedEntry

pub fn from_entry( entry: Entry, namespace: &NamespaceSecret, author: &Author ) -> Self

Create a new signed entry by signing an entry with the namespace and author.

pub fn from_parts( namespace: &NamespaceSecret, author: &Author, key: impl AsRef<[u8]>, record: Record ) -> Self

Create a new signed entries from its parts.

pub fn verify<S: PublicKeyStore>(&self, store: &S) -> Result<(), SignatureError>

Verify the signatures on this entry.

pub fn signature(&self) -> &EntrySignature

Get the signature.

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 entry(&self) -> &Entry

Get the Entry.

pub fn content_hash(&self) -> Hash

Get the content [struct@Hash] of the entry.

pub fn content_len(&self) -> u64

Get the content length of the entry.

pub fn author_bytes(&self) -> AuthorId

Get the author bytes of this entry.

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

Get the key of the entry.

pub fn timestamp(&self) -> u64

Get the timestamp of the entry.

Methods from Deref<Target = Entry>

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 content_hash(&self) -> Hash

Get the content hash of the record.

pub fn content_len(&self) -> u64

Get the content length of the record.

pub fn timestamp(&self) -> u64

Get the timestamp of the record.

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.

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 [struct@Hash] of the content data of this record.

pub fn timestamp(&self) -> u64

Get the timestamp of this record.

Trait Implementations

impl Clone for SignedEntry

fn clone(&self) -> SignedEntry

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SignedEntry

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

Formats the value using the given formatter.

impl Deref for SignedEntry

type Target = Entry

The resulting type after dereferencing.

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

Dereferences the value.

impl<'de> Deserialize<'de> for SignedEntry

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 SignedEntry

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 SignedEntry

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

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 SignedEntry

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 SignedEntry

impl StructuralPartialEq for SignedEntry