cln_plugin::options

Struct ConfigOption

Source
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§

Source§

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

Source§

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

Source

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

Source

pub fn dynamic(self) -> Self

Source§

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

Source

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

Source

pub fn dynamic(self) -> Self

Source§

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

Source

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

Source

pub fn dynamic(self) -> Self

Source§

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

Source

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

Source

pub fn dynamic(self) -> Self

Source§

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

Source

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

Source

pub fn dynamic(self) -> Self

Source§

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

Source

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

Source

pub fn dynamic(self) -> Self

Source§

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

Source

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

Source

pub fn dynamic(self) -> Self

Source§

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

Source

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

Source

pub fn dynamic(self) -> Self

Source§

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

Source

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

Source

pub fn dynamic(self) -> Self

Source§

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

Source

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

Source

pub fn dynamic(self) -> Self

Source§

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

Source

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

Source

pub fn dynamic(self) -> Self

Source§

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

Source

pub fn name(&self) -> &str

Source

pub fn description(&self) -> &str

Trait Implementations§

Source§

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

Source§

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

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

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

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a, V> Freeze for ConfigOption<'a, V>
where <V as OptionType<'a>>::DefaultValue: Freeze,

§

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

§

impl<'a, V> Send for ConfigOption<'a, V>
where <V as OptionType<'a>>::DefaultValue: Send,

§

impl<'a, V> Sync for ConfigOption<'a, V>
where <V as OptionType<'a>>::DefaultValue: Sync,

§

impl<'a, V> Unpin for ConfigOption<'a, V>
where <V as OptionType<'a>>::DefaultValue: Unpin,

§

impl<'a, V> UnwindSafe for ConfigOption<'a, V>
where <V as OptionType<'a>>::DefaultValue: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more