Struct cln_plugin::options::ConfigOption

pub struct ConfigOption<'a, V: OptionType<'a>> {
    pub name: &'a str,
    pub default: V::DefaultValue,
    pub description: &'a str,
    pub deprecated: bool,
    pub dynamic: bool,
    pub multi: bool,
}

Fields

name: &'a str

The name of the ConfigOption.

default: V::DefaultValue

The default value of the ConfigOption

description: &'a str

deprecated: bool

dynamic: bool

multi: bool

Implementations

impl<'a, V: OptionType<'a>> ConfigOption<'a, V>

pub fn build(&self) -> UntypedConfigOption

impl<'a> ConfigOption<'a, DefaultString>

pub const fn new_str_with_default( name: &'a str, default: &'a str, description: &'a str, ) -> Self

pub fn dynamic(self) -> Self

impl<'a> ConfigOption<'a, String>

pub const fn new_str_no_default(name: &'a str, description: &'a str) -> Self

pub fn dynamic(self) -> Self

impl<'a> ConfigOption<'a, DefaultStringArray>

pub const fn new_str_arr_with_default( name: &'a str, default: &'a str, description: &'a str, ) -> Self

pub fn dynamic(self) -> Self

impl<'a> ConfigOption<'a, StringArray>

pub const fn new_str_arr_no_default(name: &'a str, description: &'a str) -> Self

pub fn dynamic(self) -> Self

impl<'a> ConfigOption<'a, DefaultInteger>

pub const fn new_i64_with_default( name: &'a str, default: i64, description: &'a str, ) -> Self

pub fn dynamic(self) -> Self

impl<'a> ConfigOption<'a, Integer>

pub const fn new_i64_no_default(name: &'a str, description: &'a str) -> Self

pub fn dynamic(self) -> Self

impl<'a> ConfigOption<'a, DefaultIntegerArray>

pub const fn new_i64_arr_with_default( name: &'a str, default: i64, description: &'a str, ) -> Self

pub fn dynamic(self) -> Self

impl<'a> ConfigOption<'a, IntegerArray>

pub const fn new_i64_arr_no_default(name: &'a str, description: &'a str) -> Self

pub fn dynamic(self) -> Self

impl<'a> ConfigOption<'a, Boolean>

pub const fn new_bool_no_default(name: &'a str, description: &'a str) -> Self

pub fn dynamic(self) -> Self

impl<'a> ConfigOption<'a, DefaultBoolean>

pub const fn new_bool_with_default( name: &'a str, default: bool, description: &'a str, ) -> Self

pub fn dynamic(self) -> Self

impl<'a> ConfigOption<'a, Flag>

pub const fn new_flag(name: &'a str, description: &'a str) -> Self

pub fn dynamic(self) -> Self

impl<'a, V> ConfigOption<'a, V>

where V: OptionType<'a>,

pub fn name(&self) -> &str

pub fn description(&self) -> &str

Trait Implementations

impl<'a, V: Clone + OptionType<'a>> Clone for ConfigOption<'a, V>

where V::DefaultValue: Clone,

fn clone(&self) -> ConfigOption<'a, V>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a, V: Debug + OptionType<'a>> Debug for ConfigOption<'a, V>

where V::DefaultValue: Debug,

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

Formats the value using the given formatter.