Struct packet_formats::tcp::TcpSegment

pub struct TcpSegment<B> { /* private fields */ }

A TCP segment.

A TcpSegment shares its underlying memory with the byte slice it was parsed from or serialized to, meaning that no copying or extra allocation is necessary.

A TcpSegment - whether parsed using parse or created using TcpSegmentBuilder - maintains the invariant that the checksum is always valid.

Implementations

impl<B: ByteSlice> TcpSegment<B>

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

Iterate over the TCP header options.

pub fn body(&self) -> &[u8]

The segment body.

pub fn into_body(self) -> B

Consumes this packet and returns the body.

Note that the returned B has the same lifetime as the buffer from which this segment was parsed. By contrast, the body method returns a slice with the same lifetime as the receiver.

pub fn src_port(&self) -> NonZeroU16

The source port.

pub fn dst_port(&self) -> NonZeroU16

The destination port.

pub fn seq_num(&self) -> u32

The sequence number.

pub fn ack_num(&self) -> Option<u32>

The acknowledgement number.

If the ACK flag is not set, ack_num returns None.

pub fn psh(&self) -> bool

The PSH flag.

pub fn rst(&self) -> bool

The RST flag.

pub fn syn(&self) -> bool

The SYN flag.

pub fn fin(&self) -> bool

The FIN flag.

pub fn window_size(&self) -> u16

The sender’s window size.

pub fn header_len(&self) -> usize

The length of the header prefix and options.

pub fn builder<A: IpAddress>( &self, src_ip: A, dst_ip: A ) -> TcpSegmentBuilderWithOptions<A, ArrayVec<u8, MAX_OPTIONS_LEN>>

Constructs a builder with the same contents as this packet.

pub fn into_serializer<'a, A: IpAddress>( self, src_ip: A, dst_ip: A ) -> impl Serializer<Buffer = EmptyBuf> + Debug + 'a

where B: 'a,

Consumes this segment and constructs a [Serializer] with the same contents.

The returned Serializer has the Buffer type [EmptyBuf], which means it is not able to reuse the buffer backing this TcpSegment when serializing, and will always need to allocate a new buffer.

By consuming self instead of taking it by-reference, into_serializer is able to return a Serializer whose lifetime is restricted by the lifetime of the buffer from which this TcpSegment was parsed rather than by the lifetime on &self, which may be more restricted.

Trait Implementations

impl<B: ByteSlice, A: IpAddress> FromRaw<TcpSegmentRaw<B>, TcpParseArgs<A>> for TcpSegment<B>

type Error = ParseError

The type of error that may happen during validation.

fn try_from_raw_with( raw: TcpSegmentRaw<B>, args: TcpParseArgs<A> ) -> Result<Self, Self::Error>

Attempts to create Self from the raw form in raw with args.

impl<B: ByteSlice, A: IpAddress> ParsablePacket<B, TcpParseArgs<A>> for TcpSegment<B>

type Error = ParseError

The type of errors returned from parse and parse_mut.

fn parse_metadata(&self) -> ParseMetadata

Gets metadata about this packet required by [GrowBuffer::undo_parse].

fn parse<BV: BufferView<B>>( buffer: BV, args: TcpParseArgs<A> ) -> ParseResult<Self>

Parses a packet from a buffer.