Struct CapReader 

pub struct CapReader<R> { /* private fields */ }

Reads a cap from a reader.

Example

use std::fs::File;

use pcaparse::cap::CapReader;

let file_in = File::open("test.cap").expect("Error opening file");
let mut cap_reader = CapReader::new(file_in).unwrap();

// Read test.cap
while let Some(pkt) = cap_reader.next_packet() {
    //Check if there is no error
    let pkt = pkt.unwrap();

    //Do something
}

Implementations

impl<R> CapReader<R>

pub fn header(&self) -> CapHeader

Returns the global header of the cap.

impl<R: Read> CapReader<R>

pub fn new(reader: R) -> Result<CapReader<R>, PcapError>

Creates a new CapReader from an existing reader.

This function reads the global cap header of the file to verify its integrity.

The underlying reader must point to a valid cap file/stream.

Errors

The data stream is not in a valid cap file format.

The underlying data are not readable.

pub fn into_reader(self) -> R

Consumes Self, returning the wrapped reader.

pub fn next_packet(&mut self) -> Option<Result<CapPacket<'_>, PcapError>>

Returns the next CapPacket.

pub fn next_raw_packet(&mut self) -> Option<Result<RawCapPacket<'_>, PcapError>>

Returns the next RawCapPacket.

impl<R: AsyncRead + Unpin> CapReader<R>

pub async fn async_new(reader: R) -> Result<CapReader<R>, PcapError>

Creates a new CapReader from an existing reader.

This function reads the global cap header of the file to verify its integrity.

The underlying reader must point to a valid cap file/stream.

Errors

The data stream is not in a valid cap file format.

The underlying data are not readable.

pub fn into_async_reader(self) -> R

Consumes Self, returning the wrapped reader.

pub async fn async_next_packet( &mut self, ) -> Option<Result<CapPacket<'_>, PcapError>>

Returns the next CapPacket.

pub async fn async_next_raw_packet( &mut self, ) -> Option<Result<RawCapPacket<'_>, PcapError>>

Returns the next RawCapPacket.

Trait Implementations

impl<R> AsMut<R> for CapReader<R>

fn as_mut(&mut self) -> &mut R

Converts this type into a mutable reference of the (usually inferred) input type.

impl<R> AsRef<R> for CapReader<R>

fn as_ref(&self) -> &R

Converts this type into a shared reference of the (usually inferred) input type.

impl<R: Debug> Debug for CapReader<R>

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

Formats the value using the given formatter.

impl<R> From<(CapParser, ReadBuffer<R>)> for CapReader<R>

fn from(value: (CapParser, ReadBuffer<R>)) -> Self

Converts to this type from the input type.