Struct Segment

pub struct Segment<P> {
    pub header: SegmentHeader,
    pub data: P,
}

A TCP segment.

Fields

header: SegmentHeader

The non-payload information of the segment.

data: P

The data carried by the segment.

It is guaranteed that data.len() plus the length of the control flag (SYN or FIN) is <= MAX_PAYLOAD_AND_CONTROL_LEN

Implementations

impl<P: Payload> Segment<P>

pub fn with_data_options( seq: SeqNum, ack: Option<SeqNum>, control: Option<Control>, wnd: UnscaledWindowSize, data: P, options: Options, ) -> (Self, usize)

Creates a new segment with data and options.

Returns the segment along with how many bytes were removed to make sure sequence numbers don’t wrap around, i.e., seq.before(seq + seg.len()).

pub fn with_data( seq: SeqNum, ack: Option<SeqNum>, control: Option<Control>, wnd: UnscaledWindowSize, data: P, ) -> (Self, usize)

Creates a new segment with data.

Returns the segment along with how many bytes were removed to make sure sequence numbers don’t wrap around, i.e., seq.before(seq + seg.len()).

pub fn map_payload<R, F: FnOnce(P) -> R>(self, f: F) -> Segment<R>

Maps the payload in the segment with f.

pub fn len(&self) -> u32

Returns the length of the segment in sequence number space.

Per RFC 793 (https://tools.ietf.org/html/rfc793#page-25): SEG.LEN = the number of octets occupied by the data in the segment (counting SYN and FIN)

pub fn overlap(self, rnxt: SeqNum, rwnd: WindowSize) -> Option<Segment<P>>

Returns the part of the incoming segment within the receive window.

pub fn new( seq: SeqNum, ack: Option<SeqNum>, control: Option<Control>, wnd: UnscaledWindowSize, ) -> Self

Creates a segment with no data.

pub fn with_options( seq: SeqNum, ack: Option<SeqNum>, control: Option<Control>, wnd: UnscaledWindowSize, options: Options, ) -> Self

Creates a new segment with options but no data.

pub fn ack(seq: SeqNum, ack: SeqNum, wnd: UnscaledWindowSize) -> Self

Creates an ACK segment.

pub fn syn(seq: SeqNum, wnd: UnscaledWindowSize, options: Options) -> Self

Creates a SYN segment.

pub fn syn_ack( seq: SeqNum, ack: SeqNum, wnd: UnscaledWindowSize, options: Options, ) -> Self

Creates a SYN-ACK segment.

pub fn rst(seq: SeqNum) -> Self

Creates a RST segment.

pub fn rst_ack(seq: SeqNum, ack: SeqNum) -> Self

Creates a RST-ACK segment.

impl Segment<()>

pub fn into_empty<P: Payload>(self) -> Segment<P>

Converts this segment with () data into any P payload’s new_empty form.

Trait Implementations

impl<P: Clone> Clone for Segment<P>

fn clone(&self) -> Segment<P>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P: Debug> Debug for Segment<P>

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

Formats the value using the given formatter.

impl<P: PartialEq> PartialEq for Segment<P>

fn eq(&self, other: &Segment<P>) -> 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<'a> TryFrom<TcpSegment<&'a [u8]>> for Segment<&'a [u8]>

type Error = MalformedFlags

The type returned in the event of a conversion error.

fn try_from(from: TcpSegment<&'a [u8]>) -> Result<Self, Self::Error>

Performs the conversion.

impl<P: Copy> Copy for Segment<P>

impl<P: Eq> Eq for Segment<P>

impl<P> StructuralPartialEq for Segment<P>