Enum CustomVariableConfig 

pub enum CustomVariableConfig {
    FloatingPoint {
        initial: OrderedFloat<f64>,
    },
    SignedInteger {
        initial: i64,
    },
    UnsignedInteger {
        initial: u64,
    },
    Boolean {
        initial: bool,
    },
}

codec between StateVar values and basic Rust types. all stateful information in Compass is encoded as a vector of floating point values. a codec provides a mapping to and from types in order to represent different real-numbered and discrete information types.

because Rust does not support dependent types and trait objects cannot return “Self“s, we are limited in how we generalize over unit types. these codecs substitute for the limitations in the type system, providing a validation check on encoding and decoding to/from StateVar instances and also a codec value that can be instantiated from configuration for a given StateModel.

warning: this could backfire, but probably in extreme cases that can be avoided. for example, if the user selects esoteric integer values that are not well-represented in floating point, then an encode -> decode roundtrip may not be idempotent.

Variants

FloatingPoint

Fields

initial: OrderedFloat<f64>

SignedInteger

Fields

initial: i64

UnsignedInteger

Fields

initial: u64

Boolean

Fields

initial: bool

Implementations

impl CustomVariableConfig

pub const DEFAULT: Self

pub fn name(&self) -> String

pub fn initial(&self) -> Result<StateVariable, StateModelError>

pub fn encode_f64(&self, value: &f64) -> Result<StateVariable, StateModelError>

pub fn encode_i64(&self, value: &i64) -> Result<StateVariable, StateModelError>

pub fn encode_u64(&self, value: &u64) -> Result<StateVariable, StateModelError>

pub fn encode_bool( &self, value: &bool, ) -> Result<StateVariable, StateModelError>

pub fn decode_f64(&self, value: &StateVariable) -> Result<f64, StateModelError>

pub fn decode_i64(&self, value: &StateVariable) -> Result<i64, StateModelError>

pub fn decode_u64(&self, value: &StateVariable) -> Result<u64, StateModelError>

pub fn decode_bool( &self, value: &StateVariable, ) -> Result<bool, StateModelError>

Trait Implementations

impl Clone for CustomVariableConfig

fn clone(&self) -> CustomVariableConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CustomVariableConfig

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

Formats the value using the given formatter.

impl Default for CustomVariableConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CustomVariableConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CustomVariableConfig

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

Formats the value using the given formatter.

impl PartialEq for CustomVariableConfig

fn eq(&self, other: &CustomVariableConfig) -> 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 CustomVariableConfig

fn partial_cmp(&self, other: &CustomVariableConfig) -> 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 CustomVariableConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for CustomVariableConfig

impl Eq for CustomVariableConfig

impl StructuralPartialEq for CustomVariableConfig