Skip to main content

WireEnvelope

Struct WireEnvelope 

Source
pub struct WireEnvelope {
    pub dest_peer_addresses: Vec<Vec<u8>>,
    pub fills: Vec<SlotFill>,
    pub correlation: Option<WireCorrelation>,
    pub remaining_deadline_ns: u64,
    pub edge_rtt_reports: Vec<EdgeRttReport>,
    pub src_peer_bytes: Vec<u8>,
    pub schema_version: u32,
    pub src_peer_addresses: Vec<Vec<u8>>,
}
Expand description

The unit of wire delivery — one delivery to one peer. Per the analyzer’s batching (ANALYSIS.md §9 analyze_wire_edges), a Send op with N typed inputs packs all N as fills so one envelope completes the data-plane DAG.

Fields§

§dest_peer_addresses: Vec<Vec<u8>>

Ordered destination address list. The framework’s wire syscall populates this from the AddressBook at dispatch time — it’s the resolved snapshot of AddressBook::lookup(peer) at the moment the envelope was minted. The host’s transport adapter picks one of these entries based on its networking capabilities (IPv4 reachability, QUIC support, relay preference, etc.). Each entry is Address::to_bytes(). See docs/ADDRESSING.md for the resolution semantics; lookups that miss surface EngineStep::PeerResolveFailed instead of producing an envelope.

§fills: Vec<SlotFill>

One or more slot fills delivered atomically.

§correlation: Option<WireCorrelation>

Request/response correlation. Control planes MAY use it (Kademlia pairs FindNode ↔ FindNodeReply).

§remaining_deadline_ns: u64

PLAN tender-noodling-sky Phase 3e-iv — Dapper-style deadline propagation. Forward-direction envelopes (requests) carry the sender’s remaining budget for the whole chain. Each receiver subtracts its own service time before forwarding downstream. A value of 0 means “no propagated deadline” (the receiver falls back to its own static per_hop_budget_ns × chain_depth).

§edge_rtt_reports: Vec<EdgeRttReport>

PLAN tender-noodling-sky Phase 3e-iv — reverse-path piggyback. Response envelopes attach EdgeRttReport entries describing the sender’s observed outgoing-edge RTTs. The caller consumes the reports into AddressBookEntry.reported_outgoing so multi-hop chain budgets compose from one entry per direct neighbor.

§src_peer_bytes: Vec<u8>

Phase 10.4 — Multihash bytes of the originating peer (the sender’s PeerId.to_bytes()). Lets the receiver attribute the envelope without consulting a separate adapter-side lookup, which is required for the typed envelope_src_peer runtime surface (no PeerId(0) fabrication — see Phase 4.4 / theme T5).

§schema_version: u32

Phase 10.4 — WireEnvelope schema version. Stamped by the sender (compiler at install seam supplies a single SCHEMA_VERSION_V1 = 1). Validated by EnvelopeCodec:: decode_capped on every inbound buffer. Surfaces as EnvelopeDecodeError::VersionMismatch { got, supported } on disagreement so the receiver REJECTS unknown future versions rather than mis-parsing them. Bump when any field’s semantics (not just shape — proto is structurally forward-compatible) changes in a way old code cannot soundly handle.

§src_peer_addresses: Vec<Vec<u8>>

Sender-claimed local-address list — the snapshot of the sender’s AddressBook entry for its own PeerId at the moment the envelope was minted. Each entry is Address::to_bytes(). The receiver merges the list into its own AddressBook entry for src_peer so future replies can dial back on any of the sender’s reachable interfaces. Empty means the sender chose not to advertise (e.g. local_addresses() was empty); the receiver leaves its existing entry untouched. Bounded at decode time by EnvelopeCaps.max_src_peer_addresses + max_src_peer_address_bytes to cap adversarial pre-allocation.

Trait Implementations§

Source§

impl Clone for WireEnvelope

Source§

fn clone(&self) -> WireEnvelope

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for WireEnvelope

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for WireEnvelope

Source§

fn default() -> WireEnvelope

Returns the “default value” for a type. Read more
Source§

impl Message for WireEnvelope

Source§

fn encoded_len(&self) -> usize

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

fn clear(&mut self)

Clears the message, resetting all fields to their default.
Source§

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

Encodes the message to a buffer. Read more
Source§

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

Encodes the message to a newly allocated buffer.
Source§

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

Encodes the message with a length-delimiter to a buffer. Read more
Source§

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

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

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

Decodes an instance of the message from a buffer. Read more
Source§

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

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

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

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

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

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

impl PartialEq for WireEnvelope

Source§

fn eq(&self, other: &WireEnvelope) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for WireEnvelope

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> ErasedComponent for T
where T: Any + Send + Sync,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<T> Instrument for T

Source§

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

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

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.

Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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