Struct Data 

pub struct Data<T> { /* private fields */ }

The packet returned in response to a matching Interest.

T is the type the content decodes/encodes as; use Bytes to work with the raw payload, or a type implementing ndn_tlv::TlvEncode/ndn_tlv::TlvDecode to work with it directly.

Implementations

impl Data<Bytes>

pub fn decode_content<U>(self) -> Data<U>

where U: TlvDecode,

Decodes the raw content into a concrete type U, converting a Data<Bytes> into the corresponding Data<U>.

If decoding fails, or there was no content to begin with, the returned Data simply has none.

impl<T> Data<T>

where T: TlvEncode,

pub const fn new(name: Name, content: T) -> Self

Creates a new, unsigned Data packet for name carrying content, with its content type defaulted to ContentType::BLOB.

pub fn name(&self) -> &Name

The Data packet’s name.

pub fn set_name(&mut self, name: Name) -> &mut Self

Sets the Data packet’s name.

pub fn meta_info(&self) -> &Option<MetaInfo>

The Data packet’s MetaInfo, if set.

pub fn set_meta_info(&mut self, meta_info: Option<MetaInfo>) -> &mut Self

Sets the Data packet’s MetaInfo, or clears it if None.

pub fn content(&self) -> Option<&T>

The Data packet’s content, if set.

pub fn set_content(&mut self, content: Option<T>) -> &mut Self

Sets the Data packet’s content, or clears it if None.

pub fn encode_content(self) -> Data<Bytes>

Encodes the content to its raw TLV bytes, the inverse of Data::decode_content.

pub fn sign<S>(&mut self, sign_method: &mut S)

where S: SignMethod,

Signs the Data packet with sign_method.

pub fn sign_cert<S>(&mut self, sign_method: &S, validity_period: ValidityPeriod)

where S: SignMethod,

Signs the Data packet with sign_method, additionally recording a ValidityPeriod the signature is only considered valid within. Used to sign certificates, which need an expiry.

pub fn signature_info(&self) -> Option<&SignatureInfo>

The signature info added by Data::sign/Data::sign_cert, if the Data is signed.

pub fn is_signed(&self) -> bool

Whether the Data packet carries a signature.

pub fn matches_interest<D>(&self, interest: &Interest<D>) -> bool

where D: TlvEncode + TlvDecode,

Returns whether this Data satisfies interest by name, respecting CanBePrefix and an implicit digest component, if present.

This only checks the name; it doesn’t check MustBeFresh, since freshness depends on when the Data was received, which this packet doesn’t know.

pub fn verify<S>(&self, sign_method: &S) -> Result<(), VerifyError>

where S: SignatureVerifier + ?Sized,

Verify the signature of this Data packet with the given SignMethod

Trait Implementations

impl<T: Clone> Clone for Data<T>

fn clone(&self) -> Data<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Data<T>

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

Formats the value using the given formatter.

impl<T: Eq> Eq for Data<T>

impl<T: Hash> Hash for Data<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: PartialEq> PartialEq for Data<T>

fn eq(&self, other: &Data<T>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<T: PartialEq> StructuralPartialEq for Data<T>

impl<T> Tlv for Data<T>

where T: TlvEncode,

const TYP: usize = 6usize

The assigned type number for this TLV record

fn inner_size(&self) -> usize

The size of the payload contained within this TLV

fn critical() -> bool

Whether the TLV is critical, see tlv_critical

fn from_reader(reader: impl Read) -> Result<Self, TlvError>

where Self: TlvDecode,

Read a TLV from a type implementing Read

impl<T> TlvDecode for Data<T>

where T: TlvEncode + TlvDecode,

fn decode(bytes: &mut Bytes) -> Result<Self>

Decode the value from a bytes::Buf

impl<T> TlvEncode for Data<T>

where T: TlvEncode,

fn encode(&self) -> Bytes

Encode the value as a TLV record or part of one

fn size(&self) -> usize

The size of the encoded data in bytes