Struct pcap_file::pcap::PcapHeader

pub struct PcapHeader {
    pub magic_number: u32,
    pub version_major: u16,
    pub version_minor: u16,
    pub ts_correction: i32,
    pub ts_accuracy: u32,
    pub snaplen: u32,
    pub datalink: DataLink,
}

Pcap Global Header

Fields

magic_number: u32

Magic number

version_major: u16

Major version number

version_minor: u16

Minor version number

ts_correction: i32

GMT to local timezone correction, should always be 0

ts_accuracy: u32

Timestamp accuracy, should always be 0

snaplen: u32

Max length of captured packet, typically 65535

datalink: DataLink

DataLink type (first layer in the packet)

Methods

impl PcapHeader

pub fn from_reader<R: Read>(reader: &mut R) -> Result<PcapHeader, PcapError>

Creates a new PcapHeader from a reader

Returns an error if the reader doesn't contain a valid pcap or if there is a reading error.

pub fn from_slice(slice: &[u8]) -> Result<(&[u8], PcapHeader), PcapError>

Creates a new PcapHeader from a slice of bytes

Returns an error if the reader doesn't contain a valid pcap or if there is a reading error.

PcapError::IncompleteBuffer indicates that there is not enough data in the buffer

pub fn set_ts_resolution(&mut self, ts_resolution: TsResolution)

Set the timestamp resolution to ts_resolution by modifying the magic_number Preserve its endianness

pub fn set_endianness(&mut self, endianness: Endianness)

Change the endianness of the magic_number

pub fn write_to<W: Write, B: ByteOrder>(
    &self,
    writer: &mut W
) -> Result<(), PcapError>

Write a PcapHeader to a writer.

Writes 24o in the writer on success.

pub fn endianness(&self) -> Endianness

Return the endianness of the pcap

Panics

Panics if the magic number is invalid

pub fn ts_resolution(&self) -> TsResolution

Return the timestamp resolution of the pcap

Panics

Panics if the magic number is invalid

pub fn to_array<B: ByteOrder>(&self) -> Result<Vec<u8>, PcapError>

Deprecated since 1.0.0:

Please use write_to instead

Convert a PcapHeader to a Vec<u8>.

pub fn with_datalink(datalink: DataLink) -> PcapHeader

Deprecated since 1.0.0:

Please use the Default struct constructor instead, will be removed in 1.0

Creates a new PcapHeader with the following parameters:

PcapHeader {

    magic_number : 0xa1b2c3d4,
    version_major : 2,
    version_minor : 4,
    ts_correction : 0,
    ts_accuracy : 0,
    snaplen : 65535,
    datalink : #datalink
};

Trait Implementations

impl Clone for PcapHeader

fn clone(&self) -> PcapHeader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for PcapHeader

impl Default for PcapHeader

Creates a new PcapHeader with the default parameters:

PcapHeader {

    magic_number : 0xa1b2c3d4,
    version_major : 2,
    version_minor : 4,
    ts_correction : 0,
    ts_accuracy : 0,
    snaplen : 65535,
    datalink : DataLink::ETHERNET
};

fn default() -> Self

Returns the "default value" for a type.

impl Eq for PcapHeader

impl PartialEq<PcapHeader> for PcapHeader

fn eq(&self, other: &PcapHeader) -> bool

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

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

This method tests for !=.

impl Debug for PcapHeader

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

Formats the value using the given formatter.