Struct ButtonControl

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

Button that sends a signal when pressed. The button is only enabled when capturing.

The extcap utility can set the button text at startup using the display field, change the button text using set_label, and receive button press signals from an ExtcapControlReader.

The button is disabled and the button text is restored to the default text when not capturing.

Fields

control_number: u8

The control number, a unique identifier for this control.

display: String

The user-visible label for the button.

tooltip: Option<String>

Tooltip shown when hovering over the UI element.

Implementations

impl ButtonControl

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

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

Trait Implementations

impl ControlWithLabel for ButtonControl

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

Sets the label of this control.

impl Debug for ButtonControl

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

Formats the value using the given formatter.

impl EnableableControl for ButtonControl

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

Sets whether the control is enabled or disabled.

impl PrintSentence for ButtonControl

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 ButtonControl

fn control_number(&self) -> u8

The control number, a unique identifier for this control.