Struct MetadataEntry 

#[non_exhaustive]
pub struct MetadataEntry {
    pub content: Hash,
    pub key: String,
    pub value: String,
    pub author: String,
    pub sequence: u64,
    pub created_at: u64,
    pub signature: Option<String>,
}

Signed metadata appended to a content hash.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

content: Hash

key: String

value: String

author: String

sequence: u64

created_at: u64

signature: Option<String>

Implementations

impl MetadataEntry

pub fn new( content: Hash, key: impl Into<String>, value: impl Into<String>, sequence: u64, signing_key: &SigningKey, ) -> Result<Self>

Create and sign metadata with an Ed25519 author key.

Errors

Returns an error if metadata fields are invalid or signing fails.

pub fn new_with_time( content: Hash, key: impl Into<String>, value: impl Into<String>, sequence: u64, created_at: u64, signing_key: &SigningKey, ) -> Result<Self>

Create and sign metadata with an explicit timestamp.

Errors

Returns an error if metadata fields are invalid or signing fails.

pub fn unsigned( content: Hash, key: impl Into<String>, value: impl Into<String>, sequence: u64, created_at: u64, author: &VerifyingKey, ) -> Result<Self>

Create unsigned metadata for a specific author identity.

Call Self::sign before accepting or serializing the entry.

Errors

Returns an error if metadata fields are invalid.

pub fn sign(&mut self, signing_key: &SigningKey) -> Result<()>

Sign the entry with its declared author.

Errors

Returns an error if the signing key does not match the author.

pub fn verify_signature(&self) -> Result<()>

Verify the metadata signature and structure.

Errors

Returns an error if the metadata or signature is invalid.

pub fn validate(&self) -> Result<()>

Validate non-cryptographic metadata fields.

Errors

Returns an error if a required field or author identity is invalid.

pub fn to_bytes(&self) -> Result<Vec<u8>>

Encode the entry as JSON.

Errors

Returns an error if the entry is invalid or cannot be serialized.

pub fn from_bytes(bytes: impl AsRef<[u8]>) -> Result<Self>

Decode an entry from JSON.

Errors

Returns an error if the entry is malformed.

Trait Implementations

impl Clone for MetadataEntry

fn clone(&self) -> MetadataEntry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MetadataEntry

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MetadataEntry

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for MetadataEntry

impl PartialEq for MetadataEntry

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for MetadataEntry

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MetadataEntry