InterestBuilder

Struct InterestBuilder 

Source
pub struct InterestBuilder { /* private fields */ }
Expand description

Configurable Interest encoder.

let wire = InterestBuilder::new("/ndn/test")
    .lifetime(Duration::from_millis(2000))
    .must_be_fresh()
    .build();

Implementations§

Source§

impl InterestBuilder

Source

pub fn new(name: impl Into<Name>) -> InterestBuilder

Source

pub fn lifetime(self, d: Duration) -> InterestBuilder

Source

pub fn can_be_prefix(self) -> InterestBuilder

Source

pub fn must_be_fresh(self) -> InterestBuilder

Source

pub fn hop_limit(self, h: u8) -> InterestBuilder

Source

pub fn app_parameters(self, p: impl Into<Vec<u8>>) -> InterestBuilder

Source

pub fn forwarding_hint(self, names: Vec<Name>) -> InterestBuilder

Source

pub fn build_with_timeout(self) -> (Bytes, Duration)

Build the Interest wire and return a suitable local receive timeout.

The timeout is the Interest lifetime plus a 500 ms forwarding buffer. Use this with Consumer::fetch_with so you don’t have to compute the timeout manually:

use ndn_packet::encode::InterestBuilder;
let data = consumer.fetch_with(
    InterestBuilder::new("/ndn/test")
        .hop_limit(4)
        .forwarding_hint(vec!["/hint/hub".parse()?])
        .app_parameters(b"q=hello"),
).await?;
Source

pub fn build(self) -> Bytes

Source

pub async fn sign<F, Fut>( self, sig_type: SignatureType, key_locator: Option<&Name>, sign_fn: F, ) -> Bytes
where F: FnOnce(&[u8]) -> Fut, Fut: Future<Output = Bytes>,

Encode and sign the Interest packet (Signed Interest per NDN v0.3 §5.4).

sig_type and key_locator describe the signature algorithm and optional KeyLocator name for InterestSignatureInfo. sign_fn receives the signed region (Name through InterestSignatureInfo) and returns the raw signature bytes.

If app_parameters was not set, an empty ApplicationParameters TLV is used — signed Interests must carry ApplicationParameters per spec.

Anti-replay fields (SignatureNonce, SignatureTime, SignatureSeqNum) are included in InterestSignatureInfo if set via the builder. If none are set, a random 8-byte SignatureNonce and the current wall-clock SignatureTime are generated automatically.

Source

pub fn sign_digest_sha256(self) -> Bytes

Sign with DigestSha256 — SHA-256 of the signed region.

This is the minimum signature type accepted by NFD for management Interests on the loopback face. No key material is required; NFD verifies the signature by recomputing the SHA-256 itself.

Use this when sending management commands (rib/register, etc.) to NFD or ndnd so they do not silently drop the Interest.

Source

pub fn sign_sync<F>( self, sig_type: SignatureType, key_locator: Option<&Name>, sign_fn: F, ) -> Bytes
where F: FnOnce(&[u8]) -> Bytes,

Synchronous encode-and-sign for CPU-only signers (Ed25519, HMAC).

Trait Implementations§

Source§

impl SignWith for InterestBuilder

Source§

fn sign_with_sync( self, signer: &(dyn Signer + 'static), ) -> Result<Bytes, TrustError>

Sign this packet using the given signer (synchronous). Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more