Struct ipns_entry::entry::protobuf::IpnsEntry

pub struct IpnsEntry {
    pub value: Option<Vec<u8>>,
    pub signature_v1: Option<Vec<u8>>,
    pub validity_type: Option<i32>,
    pub validity: Option<Vec<u8>>,
    pub sequence: Option<u64>,
    pub ttl: Option<u64>,
    pub pub_key: Option<Vec<u8>>,
    pub signature_v2: Option<Vec<u8>>,
    pub data: Option<Vec<u8>>,
}

Fields

value: Option<Vec<u8>>

signature_v1: Option<Vec<u8>>

validity_type: Option<i32>

validity: Option<Vec<u8>>

sequence: Option<u64>

ttl: Option<u64>

pub_key: Option<Vec<u8>>

in order for nodes to properly validate a record upon receipt, they need the public key associated with it. For old RSA keys, its easiest if we just send this as part of the record itself. For newer ed25519 keys, the public key can be embedded in the peerID, making this field unnecessary.

signature_v2: Option<Vec<u8>>

data: Option<Vec<u8>>

Implementations

impl IpnsEntry

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

Returns the value of value, or the default value if value is unset.

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

Returns the value of signature_v1, or the default value if signature_v1 is unset.

pub fn validity_type(&self) -> ValidityType

Returns the enum value of validity_type, or the default if the field is unset or set to an invalid enum value.

pub fn set_validity_type(&mut self, value: ValidityType)

Sets validity_type to the provided enum value.

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

Returns the value of validity, or the default value if validity is unset.

pub fn sequence(&self) -> u64

Returns the value of sequence, or the default value if sequence is unset.

pub fn ttl(&self) -> u64

Returns the value of ttl, or the default value if ttl is unset.

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

Returns the value of pub_key, or the default value if pub_key is unset.

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

Returns the value of signature_v2, or the default value if signature_v2 is unset.

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

Returns the value of data, or the default value if data is unset.

impl IpnsEntry

pub fn new(data: Data, signed: Signed) -> Self

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

pub fn from_bytes(buf: &[u8]) -> Result<Self, DecodeError>

Decode protobuf bytes into an IpnsEntry Ensures the bytes are less than or equal to 10 KiB in size.

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

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

Get Deserialized IpnsEntry.data as a DAG-CBOR document

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

Confirm values in IpnsEntry protobuf match deserialized ones from IpnsEntry.data:

pub fn signables(&self) -> Result<Signables>

Trait Implementations

impl Clone for IpnsEntry

fn clone(&self) -> IpnsEntry

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IpnsEntry

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

Formats the value using the given formatter.

impl Default for IpnsEntry

fn default() -> Self

Returns the “default value” for a type.

impl Message for IpnsEntry

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>where
    B: BufMut,
    Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8, Global> where
    Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>where
    B: BufMut,
    Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8, Global> where
    Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>where
    B: Buf,
    Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>where
    B: Buf,
    Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>where
    B: Buf,
    Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>where
    B: Buf,
    Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<IpnsEntry> for IpnsEntry

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