Struct Interest 

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

A request for Data matching a Name, optionally carrying application parameters and a signature.

T is the type application parameters decode/encode as; use () for Interests that don’t carry any, Bytes to work with the raw payload, or a type implementing ndn_tlv::TlvEncode/ndn_tlv::TlvDecode to work with it directly.

Implementations

impl Interest<Bytes>

pub fn decode_application_parameters<T>(self) -> Interest<T>

where T: TlvDecode,

Decodes the raw application parameters into a concrete type T, converting an Interest<Bytes> into the curresponding Interest<T>.

If decoding fails, or there were no application parameters to begin with, the returned Interest simply has none.

impl<AppParamTy> Interest<AppParamTy>

pub fn remove_application_parameters(self) -> Interest<()>

Drops the application parameters, returning an Interest<()>.

impl<AppParamTy> Interest<AppParamTy>

where AppParamTy: TlvEncode,

pub fn make_parameters_digest( data: AppParamTy, ) -> ParametersSha256DigestComponent

Creates the ParametersSha256DigestComponent part of the name.

The component will be automatically added to the name when signing the interest, so this is only useful for unsigned interests.

pub fn add_parameters_digest(&mut self) -> &mut Self

where AppParamTy: Default + Clone,

Adds a ParametersSha256DigestComponent to the end of the name

The component will be automatically added to the name when signing the interest, so this is only useful for unsigned interests.

Empty application parameters will be set if none are set currently. Any existing ParametersSha256DigestComponent will be removed.

pub fn add_parameters_digest_unchecked(&mut self) -> &mut Self

where AppParamTy: Clone,

Adds a ParametersSha256DigestComponent to the end of the name, assuming application parameters already exist

The component will be automatically added to the name when signing the interest, so this is only useful for unsigned interests.

Any existing ParametersSha256DigestComponent will be removed.

pub fn sign<T>(&mut self, sign_method: &mut T, settings: SignSettings)

where T: SignMethod, AppParamTy: Default,

Signs the Interest with sign_method, setting empty application parameters first if none are set yet.

pub fn sign_checked<T>( &mut self, sign_method: &mut T, settings: SignSettings, ) -> Result<(), SignError>

where T: SignMethod,

Signs the Interest with sign_method, adding a signature info, signature value, and ParametersSha256DigestComponent to the name.

Fails if the Interest has no application parameters set – signed Interests are required to carry some, even if empty. see Interest::sign for a version that sets empty ones automatically.

pub fn verify<T>(&self, verifier: &T) -> Result<(), VerifyError>

where T: SignatureVerifier + ?Sized,

Verify the interest with a given signature verifier

Returns Ok(()) if the signature and the ParametersSha256DigestComponent of the name are valid

pub fn encode_application_parameters(self) -> Interest<Bytes>

Encodes the application parameters to their raw TLV bytes, the inverse of Interest::decode_application_parameters.

impl Interest<()>

pub fn new_u(name: Name) -> Self

Same as Interest::new, for callers that need to spell out that T is () for type inference to work.

impl<AppParamTy> Interest<AppParamTy>

pub fn new(name: Name) -> Self

Creates a new, unsigned Interest for name with no selectors set.

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

Sets the Interest’s name.

pub fn name(&self) -> &Name

The Interest’s name.

pub fn set_can_be_prefix(&mut self, can_be_prefix: bool) -> &mut Self

Sets whether the Interest can be satisfied by Data whose name has this Interest’s name as a prefix (see CanBePrefix).

pub fn can_be_prefix(&self) -> bool

Whether CanBePrefix is set.

pub fn set_must_be_fresh(&mut self, must_be_fresh: bool) -> &mut Self

Sets whether the Interest requires fresh Data (see MustBeFresh).

pub fn must_be_fresh(&self) -> bool

Whether MustBeFresh is set.

pub fn set_forwarding_hint( &mut self, forwarding_hint: Option<Name>, ) -> &mut Self

Sets the forwarding hint, or clears it if None (see ForwardingHint).

pub fn forwarding_hint(&self) -> Option<&Name>

The forwarding hint’s name, if set.

pub fn set_nonce(&mut self, nonce: Option<[u8; 4]>) -> &mut Self

Sets the nonce, or clears it if None (see Nonce).

pub fn nonce(&self) -> Option<&[u8; 4]>

The nonce, if set.

pub fn set_interest_lifetime( &mut self, interest_lifetime: Option<NonNegativeInteger>, ) -> &mut Self

Sets the interest lifetime in milliseconds, or clears it if None (see InterestLifetime).

pub fn interest_lifetime(&self) -> Option<NonNegativeInteger>

The interest lifetime in milliseconds, if set.

pub fn set_hop_limit(&mut self, hop_limit: Option<u8>) -> &mut Self

Sets the hop limit, or clears it if None (see HopLimit).

pub fn hop_limit(&self) -> Option<u8>

The hop limit, if set.

pub fn set_application_parameters( &mut self, params: Option<AppParamTy>, ) -> &mut Self

Sets the application parameters, or clears them if None.

pub fn application_parameters(&self) -> Option<&AppParamTy>

The application parameters, if set.

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

The signature info added by Interest::sign/Interest::sign_checked, if the Interest is signed.

pub fn is_signed(&self) -> bool

Whether the Interest carries a signature.

Trait Implementations

impl<T: Clone> Clone for Interest<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Interest<T>

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

Formats the value using the given formatter.

impl<T: Eq> Eq for Interest<T>

impl<T: Hash> Hash for Interest<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 Interest<T>

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

Equality operator ==.

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

Inequality operator !=.

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

impl<T> Tlv for Interest<T>

where T: TlvEncode,

const TYP: usize = 5usize

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 Interest<T>

where T: TlvEncode + TlvDecode,

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

Decode the value from a bytes::Buf

impl<T> TlvEncode for Interest<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