Struct r_extcap::interface::Metadata

pub struct Metadata {
    pub version: Cow<'static, str>,
    pub help_url: Cow<'static, str>,
    pub display_description: Cow<'static, str>,
}

Metadata for this extcap program. The version will be used for displaying the version information of the extcap interface in the about dialog of Wireshark.

A default implementation of Metadata is provided as Metadata::default(), which extracts these information from the version, homepage, and description attributes in the cargo manifest.

Fields

version: Cow<'static, str>

The version of this extcap program, displayed in the about dialog of Wireshark.

help_url: Cow<'static, str>

A URL linking to more details about this extcap program. This is the URL opened when the help button in the config dialog, or a HelpButtonControl is clicked.

display_description: Cow<'static, str>

A user-friendly description of the extcap program.

Trait Implementations

impl PrintSentence for Metadata

Example

use r_extcap::interface::Metadata;

let metadata = Metadata {
    version: "3.2.1-test".into(),
    help_url: "http://www.wireshark.org".into(),
    display_description: "Just for testing".into(),
};
assert_eq!(
    format!("{}", ExtcapFormatter(&metadata)),
    "extcap {version=3.2.1-test}{help=http://www.wireshark.org}{display=Just for testing}\n"
)

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.