Struct gdnative_doc::documentation::Method

pub struct Method {
    pub has_self: bool,
    pub name: String,
    pub self_type: String,
    pub parameters: Vec<(String, Type, ParameterAttribute)>,
    pub return_type: Type,
    pub documentation: String,
    pub file: PathBuf,
}

Method in an impl block.

Fields

has_self: bool

Does this method have a self parameter ?

name: String

Name of the method.

self_type: String

Name of the type that is being implemented.

parameters: Vec<(String, Type, ParameterAttribute)>

Parameters of the method (excluding self).

Contains:

• the name of the parameter
• it’s Type
• eventual attributes

return_type: Type

Return type of the method.

documentation: String

Documentation associated with the method

Note

This keeps the leading space in /// doc

file: PathBuf

File in which the method was declared

Trait Implementations

impl Clone for Method

fn clone(&self) -> Method

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Method

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

Formats the value using the given formatter.

impl Hash for Method

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,

Feeds a slice of this type into the given Hasher.

impl PartialEq<Method> for Method

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Method

impl StructuralEq for Method

impl StructuralPartialEq for Method