Struct Record 

pub struct Record { /* private fields */ }

Implementations

impl Record

pub fn new( keypair: &Keypair, value: impl AsRef<[u8]>, eol: DateTime<Utc>, seq: u64, ttl: Duration, ) -> Result<Self, Error>

Creates and signs an IPNS record pointing at value, valid until the absolute eol (End-Of-Life) timestamp. ttl is a caching hint for resolvers.

pub fn new_with_metadata( keypair: &Keypair, value: impl AsRef<[u8]>, eol: DateTime<Utc>, seq: u64, ttl: Duration, metadata: BTreeMap<String, Ipld>, ) -> Result<Self, Error>

Like Record::new but attaches additional dag-cbor metadata keys to the record. Keys must not collide with the reserved fields (Value, Validity, ValidityType, Sequence, TTL).

pub fn decode(data: impl AsRef<[u8]>) -> Result<Self, Error>

pub fn encode(&self) -> Result<Vec<u8>, Error>

impl Record

pub fn sequence(&self) -> u64

pub fn validity_type(&self) -> ValidityType

pub fn validity(&self) -> Result<DateTime<FixedOffset>, Error>

pub fn ttl(&self) -> u64

pub fn has_signature_v1(&self) -> bool

Whether the record carries a (legacy) V1 signature.

pub fn has_signature_v2(&self) -> bool

Whether the record carries a V2 signature.

pub fn data(&self) -> Result<Data, Error>

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

The raw IPNS value.

pub fn verify_signature(&self, peer_id: PeerId) -> Result<(), Error>

pub fn verify(&self, peer_id: PeerId) -> Result<(), Error>

Fully validates the record against peer_id: name binding, V2 signature, and that the EOL validity has not elapsed.

pub fn compare(&self, other: &Record) -> Result<Ordering, Error>

Orders this record against other by IPNS precedence: higher sequence wins, then the later EOL validity. Records should already be validated and refer to the same name.

Trait Implementations

impl Clone for Record

fn clone(&self) -> Record

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Record

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

Formats the value using the given formatter.