Struct etherparse::TcpSlice

pub struct TcpSlice<'a> { /* private fields */ }

Slice containing the TCP header & payload.

Implementations

impl<'a> TcpSlice<'a>

pub fn from_slice(slice: &'a [u8]) -> Result<TcpSlice<'a>, HeaderSliceError>

Try creating a TcpSlice from a slice containing the TCP header and the TCP payload.

pub fn slice(&self) -> &'a [u8]

Returns the slice containing the TCP header and payload.

pub fn header_slice(&self) -> &'a [u8]

Returns the slice containing the TCP header (including options).

pub fn payload(&self) -> &'a [u8]

Returns the slice containing the TCP payload.

pub const fn header_len(&self) -> usize

Length of the TCP header (including TCP options).

pub fn source_port(&self) -> u16

Read the destination port number in the TCP header.

pub fn destination_port(&self) -> u16

Read the destination port number in the TCP header.

pub fn sequence_number(&self) -> u32

Read the sequence number in the TCP header.

If SYN is present the sequence number is the initial sequence number (ISN) and the first data octet is ISN+1. [copied from RFC 793, page 16]

pub fn acknowledgment_number(&self) -> u32

Reads the acknowledgment number in the TCP header.

If the ACK control bit is set this field contains the value of the next sequence number the sender of the segment is expecting to receive.

Once a connection is established this is always sent.

pub fn data_offset(&self) -> u8

Read the number of 32 bit words in the TCP Header.

This indicates where the payload begins. The TCP header (even one including options) is an integral number of 32 bits long.

pub fn ns(&self) -> bool

ECN-nonce - concealment protection (experimental: see RFC 3540)

pub fn fin(&self) -> bool

Read the fin flag (no more data from sender).

pub fn syn(&self) -> bool

Reads the syn flag (synchronize sequence numbers).

pub fn rst(&self) -> bool

Reads the rst flag (reset the connection).

pub fn psh(&self) -> bool

Reads the psh flag (push function).

pub fn ack(&self) -> bool

Reads the ack flag (acknowledgment field significant).

pub fn urg(&self) -> bool

Reads the urg flag (Urgent Pointer field significant).

pub fn ece(&self) -> bool

Read the ECN-Echo flag (RFC 3168).

pub fn cwr(&self) -> bool

Reads the cwr flag (Congestion Window Reduced).

This flag is set by the sending host to indicate that it received a TCP segment with the ECE flag set and had responded in congestion control mechanism (added to header by RFC 3168).

pub fn window_size(&self) -> u16

The number of data octets beginning with the one indicated in the acknowledgment field which the sender of this segment is willing to accept.

pub fn checksum(&self) -> u16

Checksum (16 bit one’s complement) of the pseudo ip header, this tcp header and the payload.

pub fn urgent_pointer(&self) -> u16

This field communicates the current value of the urgent pointer as a positive offset from the sequence number in this segment.

The urgent pointer points to the sequence number of the octet following the urgent data. This field is only be interpreted in segments with the URG control bit set.

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

Options of the header

pub fn options_iterator(&self) -> TcpOptionsIterator<'_>

Returns an iterator that allows to iterate through all known TCP header options.

pub fn to_header(&self) -> TcpHeader

Decode all the fields and copy the results to a crate::TcpHeader` struct.

pub fn calc_checksum_ipv4( &self, source_ip: [u8; 4], destination_ip: [u8; 4] ) -> Result<u16, ValueTooBigError<usize>>

Calculates the checksum for the current header in ipv4 mode and returns the result. This does NOT set the checksum.

pub fn calc_checksum_ipv6( &self, source: [u8; 16], destination: [u8; 16] ) -> Result<u16, ValueTooBigError<usize>>

Calculates the checksum for the current header in ipv6 mode and returns the result. This does NOT set the checksum.

Trait Implementations

impl<'a> Clone for TcpSlice<'a>

fn clone(&self) -> TcpSlice<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for TcpSlice<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for TcpSlice<'a>

fn eq(&self, other: &TcpSlice<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<'a> Eq for TcpSlice<'a>

impl<'a> StructuralPartialEq for TcpSlice<'a>