Struct PcapWriter

pub struct PcapWriter<D, S>
where
    D: Device,
    S: PcapSink,
{ /* private fields */ }

A packet capture writer device.

Every packet transmitted or received through this device is timestamped and written (in the libpcap format) using the provided sink. Note that writes are fine-grained, and buffering is recommended.

The packet sink should be cheaply cloneable, as it is cloned on every transmitted packet. For example, &'a mut Vec<u8> is cheaply cloneable but &std::io::File

Implementations

impl<D: Device, S: PcapSink> PcapWriter<D, S>

pub fn new(lower: D, sink: S, mode: PcapMode) -> PcapWriter<D, S>

Creates a packet capture writer.

pub fn get_ref(&self) -> &D

Get a reference to the underlying device.

Even if the device offers reading through a standard reference, it is inadvisable to directly read from the device as doing so will circumvent the packet capture.

pub fn get_mut(&mut self) -> &mut D

Get a mutable reference to the underlying device.

It is inadvisable to directly read from the device as doing so will circumvent the packet capture.

Trait Implementations

impl<D, S> Debug for PcapWriter<D, S>

where D: Device + Debug, S: PcapSink + Debug,

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

Formats the value using the given formatter.

impl<D: Device, S> Device for PcapWriter<D, S>

where S: PcapSink,

type RxToken<'a> = RxToken<'a, <D as Device>::RxToken<'a>, S> where Self: 'a

type TxToken<'a> = TxToken<'a, <D as Device>::TxToken<'a>, S> where Self: 'a

fn capabilities(&self) -> DeviceCapabilities

Get a description of device capabilities.

fn receive( &mut self, timestamp: Instant, ) -> Option<(Self::RxToken<'_>, Self::TxToken<'_>)>

Construct a token pair consisting of one receive token and one transmit token.

fn transmit(&mut self, timestamp: Instant) -> Option<Self::TxToken<'_>>

Construct a transmit token.