Struct clightningrpc_plugin::types::RpcOption

pub struct RpcOption {
    pub name: String,
    pub opt_typ: String,
    pub default: Option<String>,
    pub description: String,
    pub deprecated: bool,
    pub value: Option<Value>,
}

Fields

name: String

option name that is specified by the core lightning user, like –foo

opt_typ: String

option type, that can be specified like the enum

default: Option<String>

default value, that can be specified only as string and core lightning will convert it for you :) smart right?

description: String

description of the option that is shows to the user when lightningd –help is typed

deprecated: bool

if the filed is deprecated

value: Option<Value>

The value specified by the user

Implementations

impl RpcOption

pub fn value<T: for<'de> Deserialize<'de>>(&self) -> T

Trait Implementations

impl Clone for RpcOption

fn clone(&self) -> RpcOption

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'de> Deserialize<'de> for RpcOption

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RpcOption

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.