Skip to main content

TcpLayer

Struct TcpLayer 

Source
pub struct TcpLayer {
    pub index: LayerIndex,
}
Expand description

A view into a TCP packet header.

Fields§

§index: LayerIndex

Implementations§

Source§

impl TcpLayer

Source

pub const fn new(start: usize, end: usize) -> Self

Create a new TCP layer view with specified bounds.

Source

pub const fn at_start() -> Self

Create a layer at offset 0 with minimum header length.

Source

pub const fn at_offset(offset: usize) -> Self

Create a layer at the specified offset with minimum header length.

Source

pub fn at_offset_dynamic(buf: &[u8], offset: usize) -> Result<Self, FieldError>

Create a layer at offset, calculating actual header length from data offset.

Source

pub fn validate(buf: &[u8], offset: usize) -> Result<(), FieldError>

Validate that the buffer contains a valid TCP header at the offset.

Source

pub fn calculate_header_len(&self, buf: &[u8]) -> usize

Calculate the actual header length from the buffer.

Source

pub fn options_len(&self, buf: &[u8]) -> usize

Get the options length (header length - 20).

Source

pub fn src_port(&self, buf: &[u8]) -> Result<u16, FieldError>

Read the source port.

Source

pub fn sport(&self, buf: &[u8]) -> Result<u16, FieldError>

Alias for src_port (Scapy compatibility).

Source

pub fn dst_port(&self, buf: &[u8]) -> Result<u16, FieldError>

Read the destination port.

Source

pub fn dport(&self, buf: &[u8]) -> Result<u16, FieldError>

Alias for dst_port (Scapy compatibility).

Source

pub fn seq(&self, buf: &[u8]) -> Result<u32, FieldError>

Read the sequence number.

Source

pub fn ack(&self, buf: &[u8]) -> Result<u32, FieldError>

Read the acknowledgment number.

Source

pub fn data_offset(&self, buf: &[u8]) -> Result<u8, FieldError>

Read the data offset (in 32-bit words).

Source

pub fn dataofs(&self, buf: &[u8]) -> Result<u8, FieldError>

Alias for data_offset (Scapy compatibility).

Source

pub fn reserved(&self, buf: &[u8]) -> Result<u8, FieldError>

Read the reserved bits (should be 0).

Source

pub fn flags_raw(&self, buf: &[u8]) -> Result<u8, FieldError>

Read the flags as raw byte.

Source

pub fn flags(&self, buf: &[u8]) -> Result<TcpFlags, FieldError>

Read the flags as a structured type.

Source

pub fn window(&self, buf: &[u8]) -> Result<u16, FieldError>

Read the window size.

Source

pub fn checksum(&self, buf: &[u8]) -> Result<u16, FieldError>

Read the checksum.

Source

pub fn chksum(&self, buf: &[u8]) -> Result<u16, FieldError>

Alias for checksum (Scapy compatibility).

Source

pub fn urgent_ptr(&self, buf: &[u8]) -> Result<u16, FieldError>

Read the urgent pointer.

Source

pub fn urgptr(&self, buf: &[u8]) -> Result<u16, FieldError>

Alias for urgent_ptr (Scapy compatibility).

Source

pub fn options_bytes<'a>(&self, buf: &'a [u8]) -> Result<&'a [u8], FieldError>

Read the options bytes (if any).

Source

pub fn options(&self, buf: &[u8]) -> Result<TcpOptions, FieldError>

Parse and return the options.

Source

pub fn set_src_port(&self, buf: &mut [u8], port: u16) -> Result<(), FieldError>

Set the source port.

Source

pub fn set_sport(&self, buf: &mut [u8], port: u16) -> Result<(), FieldError>

Alias for set_src_port (Scapy compatibility).

Source

pub fn set_dst_port(&self, buf: &mut [u8], port: u16) -> Result<(), FieldError>

Set the destination port.

Source

pub fn set_dport(&self, buf: &mut [u8], port: u16) -> Result<(), FieldError>

Alias for set_dst_port (Scapy compatibility).

Source

pub fn set_seq(&self, buf: &mut [u8], seq: u32) -> Result<(), FieldError>

Set the sequence number.

Source

pub fn set_ack(&self, buf: &mut [u8], ack: u32) -> Result<(), FieldError>

Set the acknowledgment number.

Source

pub fn set_data_offset( &self, buf: &mut [u8], offset: u8, ) -> Result<(), FieldError>

Set the data offset (in 32-bit words).

Source

pub fn set_dataofs(&self, buf: &mut [u8], offset: u8) -> Result<(), FieldError>

Alias for set_data_offset (Scapy compatibility).

Source

pub fn set_reserved( &self, buf: &mut [u8], reserved: u8, ) -> Result<(), FieldError>

Set the reserved bits.

Source

pub fn set_flags_raw(&self, buf: &mut [u8], flags: u8) -> Result<(), FieldError>

Set the flags from raw byte.

Source

pub fn set_flags( &self, buf: &mut [u8], flags: TcpFlags, ) -> Result<(), FieldError>

Set the flags from structured type.

Source

pub fn set_window(&self, buf: &mut [u8], window: u16) -> Result<(), FieldError>

Set the window size.

Source

pub fn set_checksum( &self, buf: &mut [u8], checksum: u16, ) -> Result<(), FieldError>

Set the checksum.

Source

pub fn set_chksum( &self, buf: &mut [u8], checksum: u16, ) -> Result<(), FieldError>

Alias for set_checksum (Scapy compatibility).

Source

pub fn set_urgent_ptr( &self, buf: &mut [u8], urgptr: u16, ) -> Result<(), FieldError>

Set the urgent pointer.

Source

pub fn set_urgptr(&self, buf: &mut [u8], urgptr: u16) -> Result<(), FieldError>

Alias for set_urgent_ptr (Scapy compatibility).

Source

pub fn get_field( &self, buf: &[u8], name: &str, ) -> Option<Result<FieldValue, FieldError>>

Get a field value by name.

Source

pub fn set_field( &self, buf: &mut [u8], name: &str, value: FieldValue, ) -> Option<Result<(), FieldError>>

Set a field value by name.

Source

pub fn field_names() -> &'static [&'static str]

Get list of field names.

Source

pub fn payload_len(&self, buf: &[u8], ip_payload_len: usize) -> usize

Get the payload length from IP total length. Note: TCP doesn’t have its own length field; it relies on IP layer.

Source

pub fn payload<'a>(&self, buf: &'a [u8]) -> &'a [u8]

Get a slice of the payload data.

Source

pub fn header_bytes<'a>(&self, buf: &'a [u8]) -> &'a [u8]

Get the header bytes.

Source

pub fn src_service(&self, buf: &[u8]) -> &'static str

Get the source port service name.

Source

pub fn dst_service(&self, buf: &[u8]) -> &'static str

Get the destination port service name.

Source

pub fn hashret(&self, buf: &[u8]) -> Vec<u8>

Compute hash for packet matching (like Scapy’s hashret).

Source

pub fn answers(&self, buf: &[u8], other: &TcpLayer, other_buf: &[u8]) -> bool

Check if this packet answers another (for sr() matching).

Trait Implementations§

Source§

impl Clone for TcpLayer

Source§

fn clone(&self) -> TcpLayer

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TcpLayer

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<TcpLayer> for LayerEnum

Source§

fn from(v: TcpLayer) -> LayerEnum

Converts to this type from the input type.
Source§

impl Layer for TcpLayer

Source§

fn kind(&self) -> LayerKind

Get the kind of this layer
Source§

fn summary(&self, buf: &[u8]) -> String

Get a human-readable summary of this layer
Source§

fn header_len(&self, buf: &[u8]) -> usize

Get the header length for this layer
Source§

fn hashret(&self, buf: &[u8]) -> Vec<u8>

Compute a hash for packet matching.
Source§

fn answers(&self, buf: &[u8], other: &Self, other_buf: &[u8]) -> bool

Check if this packet answers another packet.
Source§

fn field_names(&self) -> &'static [&'static str]

Get the list of field names for this layer
Source§

fn extract_padding<'a>(&self, data: &'a [u8]) -> (&'a [u8], &'a [u8])

Extract padding from the packet.
Source§

impl LayerDispatch for TcpLayer

Source§

fn dispatch_kind(&self) -> LayerKind

Get the kind of this layer.
Source§

fn dispatch_index(&self) -> &LayerIndex

Get the layer index (start/end offsets).
Source§

fn dispatch_summary(&self, buf: &[u8]) -> String

Get a human-readable summary.
Source§

fn dispatch_header_len(&self, buf: &[u8]) -> usize

Get the header length in bytes.
Source§

fn dispatch_hashret(&self, buf: &[u8]) -> Vec<u8>

Compute a hash for packet matching.
Source§

fn dispatch_field_names(&self) -> &'static [&'static str]

Get field names for this layer type.
Source§

fn dispatch_get_field( &self, buf: &[u8], name: &str, ) -> Option<Result<FieldValue, FieldError>>

Get a field value by name.
Source§

fn dispatch_set_field( &self, buf: &mut [u8], name: &str, value: FieldValue, ) -> Option<Result<(), FieldError>>

Set a field value by name.
Source§

fn dispatch_show_fields(&self, buf: &[u8]) -> Vec<(&'static str, String)>

Get show-fields output.
Source§

impl TryInto<TcpLayer> for LayerEnum

Source§

type Error = &'static str

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<TcpLayer, <Self as TryInto<TcpLayer>>::Error>

Performs the conversion.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V