Enum geodesy::OpParameter

pub enum OpParameter {
    Flag {
        key: &'static str,
    },
    Natural {
        key: &'static str,
        default: Option<usize>,
    },
    Integer {
        key: &'static str,
        default: Option<i64>,
    },
    Real {
        key: &'static str,
        default: Option<f64>,
    },
    Series {
        key: &'static str,
        default: Option<&'static str>,
    },
    Text {
        key: &'static str,
        default: Option<&'static str>,
    },
    Texts {
        key: &'static str,
        default: Option<&'static str>,
    },
}

The OpParameter enumeration is used to represent which defining parameters are valid for a given Operation.

The individual Operation implementations use these to define the types of the parameters accepted, and whether they are required (in which case the provided default value is set to None), or optional (in which case, a default value of the proper type is provided). The odd man out here is the Flag type: Since a flag is a boolean which is true if present and false if not, it does not make much sense to provide a default in this case.

Any other parameters given should be ignored, but warned about.

For a given operation, the union of the sets of its required and optional parameters is called the gamut of the operation.

Variants

Flag

A flag is a boolean that is true if present, false if not

Fields

key: &'static str

Natural

The natural numbers + zero (𝐍₀ or 𝐖 in math terms)

Fields

key: &'static str

default: Option<usize>

Integer

Integers (𝐙 in math terms)

Fields

key: &'static str

default: Option<i64>

Real

Reals (𝐑 in math terms)

Fields

key: &'static str

default: Option<f64>

Series

A series of reals (𝐑ⁿ in math terms)

Fields

key: &'static str

default: Option<&'static str>

Text

Any kind of text

Fields

key: &'static str

default: Option<&'static str>

Texts

Any set of comma-separated texts

Fields

key: &'static str

default: Option<&'static str>

Trait Implementations

impl Clone for OpParameter

fn clone(&self) -> OpParameter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OpParameter

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

Formats the value using the given formatter.

impl PartialEq for OpParameter

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

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

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 StructuralPartialEq for OpParameter