Struct weechat::config::BooleanOptionSettings

pub struct BooleanOptionSettings { /* fields omitted */ }

Settings for a new boolean option.

Implementations

impl BooleanOptionSettings

pub fn new<N: Into<String>>(name: N) -> Self

Create new settings that can be used to create a new boolean option.

Arguments

• name - The name of the new option.

pub fn description<D: Into<String>>(self, descritpion: D) -> Self

Set the description of the option.

Arguments

• description - The description of the new option.

pub fn default_value(self, value: bool) -> Self

Set the default value of the option.

This is the value the option will have if it isn't set by the user. If the option is reset, the option will take this value.

Arguments

• value - The value that should act as the default value.

pub fn set_change_callback(
    self,
    callback: impl FnMut(&Weechat, &BooleanOption) + 'static
) -> Self

Set the callback that will run when the value of the option changes.

Arguments

• callback - The callback that will be run.

Examples

use weechat::Weechat;
use weechat::config::BooleanOptionSettings;

let settings = BooleanOptionSettings::new("autoconnect")
    .set_change_callback(|weechat, option| {
        Weechat::print("Option changed");
    });

Trait Implementations

impl Default for BooleanOptionSettings

fn default() -> BooleanOptionSettings

Returns the "default value" for a type.