Struct PacketCapture

pub struct PacketCapture<State> { /* private fields */ }

Basic PacketCapture type

Marker as PhantomData allow compile-time checking of struct use

Implementations

impl PacketCapture<Uninitialized>

Uninitialized PacketCaptures can be created only

pub fn new_from_interface( interface_name: &str, ) -> Result<PacketCapture<Initialized>, Box<dyn Error>>

Create a PacketCapture

Takes an interface name and returns an Initialized PacketCapture

pub fn new_with_default() -> Result<PacketCapture<Initialized>, Box<dyn Error>>

Create a PacketCapture

Returns an Initialized PacketCapture with the default interface

impl PacketCapture<Initialized>

Initialized PacketCaptures can start a capture or a live processing callback

pub fn start_capture(&self) -> PacketCapture<Started>

Start capturing

Stores packets that can be accessed later with the results methods

pub fn start_live_process( &self, callback: impl FnMut(Vec<u8>) + Send + 'static, ) -> PacketCapture<Started>

Start live processing

Takes (and calls) a callback function on incoming streams of bytes

impl PacketCapture<Started>

Started PacketCaptures can stop only

pub fn stop_capture(&self) -> PacketCapture<Completed>

Stop capturing

Not much more to it

impl PacketCapture<Completed>

Completed PacketCaptures return results in various formats

pub fn results_raw(&self) -> Arc<[Vec<u8>]>

Results returned as raw vectors of bytes

pub fn results_as_ethernet(&self) -> EthernetFrameCollection<'_>

Results returned as ethernet frames

pub fn results_as_ipv4(&self) -> Ipv4PacketCollection<'_>

Results returned as ipv4 packets

pub fn results_as_tcp(&self) -> TcpSegmentCollection<'_>

Results returned as tcp segments

Trait Implementations

impl<State: Debug> Debug for PacketCapture<State>

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

Formats the value using the given formatter.