Struct BooleanControl

pub struct BooleanControl {
    pub control_number: u8,
    pub display: String,
    pub tooltip: Option<String>,
    pub default_value: bool,
}

A checkbox which lets the user set a true / false value.

The extcap utility can set a default value at startup, change the value using set_checked, and receive value changes from an ExtcapControlReader. When starting a capture Wireshark will send the value if different from the default value.

Fields

control_number: u8

The control number, a unique identifier for this control.

display: String

The user-visible label for the check box.

tooltip: Option<String>

Tooltip shown when hovering over the UI element.

default_value: bool

Whether the control should be checked or unchecked by default

Implementations

impl BooleanControl

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

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

impl BooleanControl

pub fn set_checked<'a>(&self, checked: bool) -> ControlPacket<'a>

Set whether this checkbox is checked.

Trait Implementations

impl ControlWithLabel for BooleanControl

fn set_label<'a>(&self, label: &'a str) -> ControlPacket<'a>

Sets the label of this control.

impl Debug for BooleanControl

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

Formats the value using the given formatter.

impl EnableableControl for BooleanControl

fn set_enabled(&self, enabled: bool) -> ControlPacket<'static>

Sets whether the control is enabled or disabled.

impl PrintSentence for BooleanControl

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 BooleanControl

fn control_number(&self) -> u8

The control number, a unique identifier for this control.