Struct bitcoinrpc_util::RPCArg

pub struct RPCArg { /* private fields */ }

---

Implementations

impl RPCArg

pub fn new( name: String, ty: Type, fallback: Fallback, description: String, oneline_description: Option<&str>, type_str: Vec<String>, hidden: Option<bool> ) -> Self

pub fn new_with_inner( name: String, ty: Type, fallback: Fallback, description: String, inner: Vec<RPCArg>, oneline_description: Option<&str>, type_str: Vec<String> ) -> Self

impl RPCArg

pub fn get_first_name(&self) -> String

| Return the first of all aliases |

pub fn get_name(&self) -> String

| Return the name, throws when there are | aliases |

pub fn is_optional(&self) -> bool

impl RPCArg

pub fn to_string_obj(&self, oneline: bool) -> String

| Return the type string of the argument | when it is in an object (dict). | | Set oneline to get the oneline representation | (less whitespace) |

pub fn to_string(&self, oneline: bool) -> String

| Return the type string of the argument. | | Set oneline to allow it to be overridden | by a custom oneline type string (m_oneline_description). |

Trait Implementations

impl ToDescriptionString for RPCArg

fn to_description_string(&self) -> String

| Return the description string, including | the argument type and whether the argument | is required. |