Skip to main content

RwndDecision

Struct RwndDecision 

Source
pub struct RwndDecision {
    pub set_rcv_buf: Option<u64>,
    pub app_read_bytes: Option<u64>,
}
Expand description

A single receive-side decision emitted by a RwndTrace.

The two fields are independent, and between them they say what the receiver does for this step’s duration.

set_rcv_buf sizes the receive buffer. On its own it also states that the application is keeping up with it: the buffer holds that many bytes, the advertised window is held at that value, and the application drains continuously so the window’s right edge slides forward with the data received. That models a receiver whose buffer stopped growing – in-flight ends up limited by the window, and the window itself stays put.

app_read_bytes states the opposite situation: over this step the application reads exactly that many bytes and then stops. The window is whatever is left of the buffer once the unread backlog is subtracted, so it shrinks as data arrives and reaches zero when the buffer fills. That models a receiver whose application is the bottleneck.

Because the fields are independent, all four combinations are meaningful and none is a special case:

set_rcv_bufapp_read_bytesmeaning
Some(n)Nonebuffer n, window pinned at n, application drains continuously
NoneSome(m)read m bytes against the standing buffer; window is what is left
Some(n)Some(m)resize the buffer to n, then read m bytes from it
NoneNonecarry the previous configuration forward for this step

§Both fields on one step

The two apply in order: the buffer is resized first, and the read is taken against the new size. Three consequences are worth stating outright, because they are what distinguishes this from a buffer-only step:

  • The window is not pinned. The “application keeps up” half of set_rcv_buf belongs to a step that states no read. Once app_read_bytes is present it is the application’s behaviour, so the window follows from n - unread and decays as data arrives, exactly as for a read-only step. A step of set_rcv_buf: n and app_read_bytes: m is therefore not equivalent to a buffer-only step of n followed by a read of m.
  • The backlog survives the resize. Only the capacity changes; bytes already received and not yet read stay unread. Resizing does not discard, deliver, or otherwise account for them.
  • The window saturates at zero. With unread bytes outstanding the window is n.saturating_sub(unread), so resizing to a value at or below the current backlog advertises a zero window until the application reads its way back under the new size. This is the intended way to state a receiver that shrank its buffer while behind.

Fields§

§set_rcv_buf: Option<u64>

If Some, size the receive buffer to this many bytes and hold the advertised window there, with the application draining continuously.

§app_read_bytes: Option<u64>

If Some, the application reads exactly this many bytes over this step and then stops; the window follows from what is left unread.

Trait Implementations§

Source§

impl Clone for RwndDecision

Source§

fn clone(&self) -> RwndDecision

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 RwndDecision

Source§

impl Debug for RwndDecision

Source§

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

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

impl Default for RwndDecision

Source§

fn default() -> RwndDecision

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

impl Eq for RwndDecision

Source§

impl PartialEq for RwndDecision

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for RwndDecision

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,

Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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 = !

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