Struct DocumentedFunction 

pub struct DocumentedFunction {
    pub name: String,
    pub full_path: String,
    pub signature: String,
    pub description: String,
    pub parameters: Vec<Parameter>,
    pub return_type: String,
    pub examples: Vec<InteractiveExample>,
    pub is_async: bool,
}

Documented function

Fields

name: String

Function name

full_path: String

Full path

signature: String

Function signature

description: String

Description

parameters: Vec<Parameter>

Parameters

return_type: String

Return type

examples: Vec<InteractiveExample>

Examples

is_async: bool

Async function

Trait Implementations

impl Clone for DocumentedFunction

fn clone(&self) -> DocumentedFunction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentedFunction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DocumentedFunction

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DocumentedFunction

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

where __S: Serializer,

Serialize this value into the given Serde serializer.