Struct FunctionDoc 

pub struct FunctionDoc {
    pub symbol: Option<String>,
    pub annotations: Vec<FunctionAnnotation>,
    pub params: Vec<DocParam>,
    pub returns: Option<DocReturns>,
    pub description: Vec<String>,
    pub since: Option<Version>,
    pub deprecated: Option<(Version, Option<String>)>,
}

Fields

symbol: Option<String>

annotations: Vec<FunctionAnnotation>

params: Vec<DocParam>

returns: Option<DocReturns>

description: Vec<String>

since: Option<Version>

deprecated: Option<(Version, Option<String>)>

Implementations

impl FunctionDoc

pub fn from_node(node: Node<'_>, source: &[u8]) -> Option<Self>

pub fn from_node_for( node: Node<'_>, source: &[u8], expected_name: &str, ) -> Option<Self>

pub fn param(&self, name: &str) -> Option<&DocParam>

pub fn param_has_annotation( &self, param: &str, annotation: &ParamAnnotation, ) -> bool

pub fn return_transfer(&self) -> Option<&TransferKind>

Trait Implementations

impl Clone for FunctionDoc

fn clone(&self) -> Self

Returns a duplicate 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 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.