Struct FunctionDocumentation 

pub struct FunctionDocumentation {
    pub documentation: String,
    pub parameters: Vec<FunctionParameterDocumentation>,
    pub returns: Vec<DocumentationSymbol>,
    pub learn_more_link: String,
    pub code_sample: String,
}

Fields

documentation: String

parameters: Vec<FunctionParameterDocumentation>

returns: Vec<DocumentationSymbol>

learn_more_link: String

code_sample: String

Trait Implementations

impl Clone for FunctionDocumentation

fn clone(&self) -> FunctionDocumentation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionDocumentation

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

Formats the value using the given formatter.

impl Default for FunctionDocumentation

fn default() -> FunctionDocumentation

Returns the “default value” for a type.

impl Eq for FunctionDocumentation

impl Hash for FunctionDocumentation

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for FunctionDocumentation

fn eq(&self, other: &FunctionDocumentation) -> 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 StructuralPartialEq for FunctionDocumentation