Enum Options

pub enum Options {
    Handshake(HandshakeOptions),
    Segment(SegmentOptions),
}

Contains all supported TCP options.

Variants

Handshake(HandshakeOptions)

Options present in a handshake segment.

Segment(SegmentOptions)

Options present in a regular segment.

Implementations

impl Options

pub fn iter(&self) -> impl Iterator<Item = TcpOption<'_>> + Debug + Clone

Returns an iterator over the contained options.

pub fn new_with_handshake(handshake: bool) -> Self

Returns a new empty Options with the variant dictated by handshake.

pub fn from_iter<'a>( handshake: bool, iter: impl IntoIterator<Item = TcpOption<'a>>, ) -> Self

Creates a new Options from an iterator of TcpOption.

If handshake is true, only the handshake options will be parsed. Otherwise only the non-handshake options are parsed.

pub fn window_scale(&self) -> Option<WindowScale>

Reads the window scale if this is an Options::Handshake.

pub fn mss(&self) -> Option<Mss>

Reads the mss option if this is an Options::Handshake.

pub fn sack_permitted(&self) -> bool

Returns true IFF this is an Options::Handshake and its [HandShakeOptions::sack_permitted] is set.

pub fn sack_blocks(&self) -> &SackBlocks

Returns the segment’s selective ack blocks.

Returns a reference to empty blocks if this is not Options::Segment.

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Self

Returns the “default value” for a type.

impl From<HandshakeOptions> for Options

fn from(value: HandshakeOptions) -> Self

Converts to this type from the input type.

impl From<SegmentOptions> for Options

fn from(value: SegmentOptions) -> Self

Converts to this type from the input type.

impl PartialEq for Options

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

impl StructuralPartialEq for Options