Skip to main content

StreamWindow

Struct StreamWindow 

Source
pub struct StreamWindow {
    pub stream_id: u64,
    pub total_consumed: u64,
    pub ack_seq: u64,
}
Expand description

Receiver → sender credit grant. Authoritative: total_consumed is the receiver’s cumulative bytes-consumed count on the named stream since it was opened. The sender uses this to recompute tx_credit_remaining = tx_window - (tx_bytes_sent - total_consumed), making the mechanism self-healing against lost grants.

§Consumer-side validation

The codec accepts any total_consumed: u64. Pre-fix the doc- comment’s “self-healing” framing implied no further validation was needed, but the formula tx_credit_remaining = tx_window - (tx_bytes_sent - total_consumed) underflows if a malformed or hostile peer sends total_consumed > tx_bytes_sent. The consumer MUST clamp total_consumed to its local tx_bytes_sent watermark before applying. StreamState::apply_authoritative_grant (adapter/net/session.rs:1153-1154) does this today; any future consumer of this codec must do the same. The codec layer cannot do the clamp itself because it doesn’t know the sender’s local state.

Fields§

§stream_id: u64

Stream the grant applies to.

§total_consumed: u64

Receiver’s cumulative consumed-byte count on this stream.

Consumers MUST clamp this to the local tx_bytes_sent watermark before deriving credit.

§ack_seq: u64

Receiver’s cumulative reliable ack — the lowest sequence not yet contiguously received (next_expected). The sender prunes its retransmit window of everything below this (H-9). 0 for non-reliable receive streams (nothing to prune).

Implementations§

Source§

impl StreamWindow

Source

pub fn encode(&self) -> [u8; 24]

Encode to a fixed 16-byte buffer.

Source

pub fn decode(data: &[u8]) -> Result<Self, StreamWindowCodecError>

Decode a fixed-size message. Returns an error on truncated or oversize input.

Trait Implementations§

Source§

impl Clone for StreamWindow

Source§

fn clone(&self) -> StreamWindow

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 Copy for StreamWindow

Source§

impl Debug for StreamWindow

Source§

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

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

impl Eq for StreamWindow

Source§

impl PartialEq for StreamWindow

Source§

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

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> 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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Same for T

Source§

type Output = T

Should always be Self
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<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