Enum EconomicsClass 

pub enum EconomicsClass {
    Observed,
    Counted,
    Derived,
    Estimated,
    Counterfactual,
}

How a number came to be. The classes are ordered from strongest to weakest, and a value computed from several inputs is never stronger than the weakest of them.

use majordomus_cli::economics::model::EconomicsClass;
assert_eq!(serde_json::to_value(EconomicsClass::Counterfactual).unwrap(), "counterfactual");
let parsed: EconomicsClass = serde_json::from_value("observed".into()).unwrap();
assert!(parsed < EconomicsClass::Estimated, "a stronger class sorts first");

Variants

Observed

Returned by the provider or its harness at run time and recorded unmodified.

Counted

Computed deterministically from bytes on disk with a named, pinned tokenizer.

Derived

Arithmetic over observed or counted values.

Estimated

A number standing in for one nobody measured. Never compared, never published.

Counterfactual

What a mechanism would have avoided, modelled rather than observed.

Implementations

impl EconomicsClass

pub fn weakest(self, other: EconomicsClass) -> EconomicsClass

The weaker of two classes: what a value computed from both may call itself.

use majordomus_cli::economics::model::EconomicsClass::*;
assert_eq!(Observed.weakest(Counted), Counted);
assert_eq!(Counterfactual.weakest(Observed), Counterfactual);

pub fn is_measurement(self) -> bool

Whether a value of this class is a measurement a comparison may rest on: observed, counted, or derived from those. Estimates and counterfactuals are not.

use majordomus_cli::economics::model::EconomicsClass;
assert!(EconomicsClass::Counted.is_measurement());
assert!(!EconomicsClass::Estimated.is_measurement());

pub fn word(self) -> &'static str

The word a surface prints for this class.

assert_eq!(majordomus_cli::economics::model::EconomicsClass::Counted.word(), "counted");

Trait Implementations

impl Clone for EconomicsClass

fn clone(&self) -> EconomicsClass

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for EconomicsClass

impl Debug for EconomicsClass

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EconomicsClass

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for EconomicsClass

impl Hash for EconomicsClass

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for EconomicsClass

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Ord for EconomicsClass

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for EconomicsClass

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for EconomicsClass

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for EconomicsClass

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for EconomicsClass