Struct gm_docs_parser::GmManualConstant

pub struct GmManualConstant {
    pub name: String,
    pub description: String,
    pub link: Url,
    pub secondary_descriptors: Option<BTreeMap<String, String>>,
}

A constant parsed from the GmManual.

Because parsing constants is difficult, none of these fields are guarenteed to be non-empty except for [name]. Additionally, a constant might have more data than just a description -- if that is the case, additional data will be noted in [secondary_descriptors]. As a consequence of this, if the description is empty, then secondary_descriptors will also always be empty.

Fields

name: String

The name of the constant

description: String

A description of the constant

link: Url

The link to the webpage.

secondary_descriptors: Option<BTreeMap<String, String>>

Additional descriptors present. Most of the time, this will be None, but can have some Descriptors and Values present.

Trait Implementations

impl Clone for GmManualConstant

fn clone(&self) -> GmManualConstant

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GmManualConstant

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GmManualConstant

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

Deserialize this value from the given Serde deserializer.

impl Eq for GmManualConstant

impl Ord for GmManualConstant

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

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

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

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

This method tests for !=.

impl PartialOrd<GmManualConstant> for GmManualConstant

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

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

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

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

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

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

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

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

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

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

impl Serialize for GmManualConstant

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 GmManualConstant

impl StructuralPartialEq for GmManualConstant