Struct WindowSize

pub struct WindowSize(/* private fields */);

A witness type for TCP window size.

Per RFC 7323 Section 2.3:

…, the above constraints imply that two times the maximum window size must be less than 2^31, or max window < 2^30

Implementations

impl WindowSize

pub const MAX: WindowSize

The largest possible window size.

pub const ZERO: WindowSize

The smallest possible window size.

pub const ONE: WindowSize

A window size of 1, the smallest nonzero window size.

pub const DEFAULT: WindowSize

The Netstack3 default window size.

pub const fn from_u32(wnd: u32) -> Option<Self>

Create a new WindowSize from the provided u32.

If the provided window size is out of range, then None is returned.

pub fn saturating_add(self, rhs: u32) -> Self

Add a u32 to this WindowSize, saturating at WindowSize::MAX.

pub fn new(wnd: usize) -> Option<Self>

Create a new WindowSize, returning None if the argument is out of range.

pub fn checked_sub(self, diff: usize) -> Option<Self>

Subtract diff from self, returning None if the result would be negative.

pub fn saturating_sub(self, diff: usize) -> Self

Subtract diff from self returning WindowSize::ZERO if the result would be negative.

pub fn scale(self) -> WindowScale

The window scale that needs to be advertised during the handshake.

pub fn halved(self) -> WindowSize

Returns this WindowSize with a halved value

Trait Implementations

impl Add<WindowSize> for SeqNum

type Output = SeqNum

The resulting type after applying the + operator.

fn add(self, WindowSize: WindowSize) -> Self::Output

Performs the + operation.

impl Clone for WindowSize

fn clone(&self) -> WindowSize

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WindowSize

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

Formats the value using the given formatter.

impl From<WindowSize> for u32

fn from(WindowSize: WindowSize) -> Self

Converts to this type from the input type.

impl From<WindowSize> for usize

fn from(WindowSize: WindowSize) -> Self

Converts to this type from the input type.

impl Ord for WindowSize

fn cmp(&self, other: &WindowSize) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for WindowSize

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for WindowSize

fn partial_cmp(&self, other: &WindowSize) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Shr<WindowScale> for WindowSize

type Output = UnscaledWindowSize

The resulting type after applying the >> operator.

fn shr(self, WindowScale: WindowScale) -> Self::Output

Performs the >> operation.

impl Sub<WindowSize> for SeqNum

type Output = SeqNum

The resulting type after applying the - operator.

fn sub(self, WindowSize: WindowSize) -> Self::Output

Performs the - operation.

impl Copy for WindowSize

impl Eq for WindowSize

impl StructuralPartialEq for WindowSize