Struct ControlPacket

pub struct ControlPacket<'a> {
    pub sync_pipe_indication: u8,
    pub message_length: u32,
    pub control_number: u8,
    pub command: ControlCommand,
    pub payload: Cow<'a, [u8]>,
}

Control packets for the extcap interface. This is used for communication of control data between Wireshark and this extcap program.

Reference: https://www.wireshark.org/docs/wsdg_html_chunked/ChCaptureExtcap.html#_messages

Fields

sync_pipe_indication: u8

The common sync pipe indication. This protocol uses the value “T”.

message_length: u32

Length of payload + 2 bytes for control_number and command.

control_number: u8

Unique number to identify the control, as previously returned in the {control} declarations returned in the --extcap-interfaces phase. This number also gives the order of the controls in the interface toolbar. The control number, a unique identifier for this control.

command: ControlCommand

The command associated with this packet. See ControlCommand for details.

payload: Cow<'a, [u8]>

Payload specific to the command. For example, the payload for StatusbarMessage is the message string.

Implementations

impl<'a> ControlPacket<'a>

pub fn new_with_payload<CowSlice: Into<Cow<'a, [u8]>>>( control_number: u8, command: ControlCommand, payload: CowSlice, ) -> Self

Creates a new control packet with a payload.

pub fn new(control_number: u8, command: ControlCommand) -> Self

Creates a new control packet with an empty payload.

pub fn to_header_bytes(&self) -> [u8; 6]

Outputs the serialzied bytes of the header to send back to wireshark.

pub fn into_owned(self) -> ControlPacket<'static>

Turns the given ControlPacket into a ControlPacket with fully owned data and ’static lifetime.

pub fn send(self, sender: &mut ExtcapControlSender) -> Result<()>

Sends this control packet to Wireshark using the given sender.

pub async fn send_async(self, sender: &mut ExtcapControlSender) -> Result<()>

Sends this control packet to Wireshark using the given sender.

Trait Implementations

impl<'a> Clone for ControlPacket<'a>

fn clone(&self) -> ControlPacket<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ControlPacket<'a>

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

Formats the value using the given formatter.

impl<'a, 'nom> Parse<&'nom [u8]> for ControlPacket<'a>

where 'nom: 'a,

fn parse_be(orig_i: &'nom [u8]) -> IResult<&'nom [u8], Self>

Parse input as Big-Endian

fn parse_le(orig_i: &'nom [u8]) -> IResult<&'nom [u8], Self>

Parse input as Little-Endian

fn parse(orig_i: &'nom [u8]) -> IResult<&'nom [u8], Self>

Parse input, not knowing the endianness

impl<'a> PartialEq for ControlPacket<'a>

fn eq(&self, other: &ControlPacket<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Eq for ControlPacket<'a>

impl<'a> StructuralPartialEq for ControlPacket<'a>