Struct r_extcap::controls::LoggerControl

pub struct LoggerControl {
    pub control_number: u8,
    pub display: String,
    pub tooltip: Option<String>,
}

A logger mechanism where the extcap utility can send log entries to be presented in a log window. This communication is unidirectional from this extcap program to Wireshark.

A button will be displayed in the toolbar which will open the log window when clicked.

Fields

control_number: u8

The control number, a unique identifier for this control.

display: String

Label of the button that opens the log window.

tooltip: Option<String>

Tooltip shown when hovering over the UI element.

Implementations

impl LoggerControl

pub fn builder() -> LoggerControlBuilder<((), (), ())>

Create a builder for building LoggerControl. On the builder, call .control_number(...), .display(...), .tooltip(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of LoggerControl.

impl LoggerControl

pub fn clear_and_add_log<'a>(&self, log: Cow<'a, str>) -> ControlPacket<'a>

Clear the log and add the given log the entry to the window.

pub fn add_log<'a>(&self, log: Cow<'a, str>) -> ControlPacket<'a>

Add the log entry to the log window.

Trait Implementations

impl Debug for LoggerControl

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

Formats the value using the given formatter.

impl PrintSentence for LoggerControl

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

The extcap interface expects certain output “sentences” to stdout to communicate with Wireshark, like

fn print_sentence(&self)

Prints the extcap sentence to stdout.

impl ToolbarControl for LoggerControl

fn control_number(&self) -> u8

The control number, a unique identifier for this control.