Struct gm_docs_parser::GmManualFunction

pub struct GmManualFunction {
    pub name: String,
    pub parameters: Vec<GmManualFunctionParameter>,
    pub required_parameters: usize,
    pub is_variadic: bool,
    pub example: String,
    pub description: String,
    pub returns: String,
    pub link: Url,
}

A function scraped from the Gm Manual.

Fields

name: String

The name of the function

parameters: Vec<GmManualFunctionParameter>

The parameters of the function.

required_parameters: usize

The count of the number of required parameters.

is_variadic: bool

By variadic, we mean if the final parameter can take "infinite" arguments. Examples are ds_list_add, where users can invoke it as ds_list_add(list, index, 1, 2, 3, 4 /* etc */);

example: String

The example given in the Manual.

description: String

The description of what the function does.

returns: String

What the function returns.

link: Url

The link to the webpage.

Trait Implementations

impl Clone for GmManualFunction

fn clone(&self) -> GmManualFunction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GmManualFunction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GmManualFunction

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

Deserialize this value from the given Serde deserializer.

impl Eq for GmManualFunction

impl Ord for GmManualFunction

fn cmp(&self, other: &GmManualFunction) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<GmManualFunction> for GmManualFunction

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

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

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

This method tests for !=.

impl PartialOrd<GmManualFunction> for GmManualFunction

fn partial_cmp(&self, other: &GmManualFunction) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &GmManualFunction) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &GmManualFunction) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &GmManualFunction) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &GmManualFunction) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for GmManualFunction

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

Serialize this value into the given Serde serializer.

impl StructuralEq for GmManualFunction

impl StructuralPartialEq for GmManualFunction