Struct gm_docs_parser::GmManual

pub struct GmManual {
    pub functions: BTreeMap<String, GmManualFunction>,
    pub variables: BTreeMap<String, GmManualVariable>,
    pub constants: BTreeMap<String, GmManualConstant>,
}

The typings for the Entire Manual. This can be read as one massive Json.

Fields

functions: BTreeMap<String, GmManualFunction>

The built in functions within the manual created by Yyg.

variables: BTreeMap<String, GmManualVariable>

The built in variables within the manual created by Yyg.

constants: BTreeMap<String, GmManualConstant>

Many of the built in constants within the manual created by Yyg. Constants are difficult to accurately scrape from the documentation, so there will be missing constants as the scrapper gets better and better at finding them.

Trait Implementations

impl Clone for GmManual

fn clone(&self) -> GmManual

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GmManual

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GmManual

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

Deserialize this value from the given Serde deserializer.

impl Eq for GmManual

impl Ord for GmManual

fn cmp(&self, other: &GmManual) -> 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<GmManual> for GmManual

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

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

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

This method tests for !=.

impl PartialOrd<GmManual> for GmManual

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

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

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

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

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

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

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

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

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

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

impl Serialize for GmManual

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 GmManual

impl StructuralPartialEq for GmManual