Struct FunctionDoc

pub struct FunctionDoc {
    pub details: Option<String>,
    pub params: Option<HashMap<String, String>>,
    pub returns: Option<HashMap<String, String>>,
}

Fields

details: Option<String>

A description of the function

params: Option<HashMap<String, String>>

A description of the function parameters

returns: Option<HashMap<String, String>>

A description of the function return values. only for read functions

Implementations

impl FunctionDoc

pub fn new() -> FunctionDoc

Trait Implementations

impl Clone for FunctionDoc

fn clone(&self) -> FunctionDoc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionDoc

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

Formats the value using the given formatter.

impl Default for FunctionDoc

fn default() -> FunctionDoc

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FunctionDoc

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FunctionDoc

fn eq(&self, other: &FunctionDoc) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for FunctionDoc

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FunctionDoc