Enum Parameter 

pub enum Parameter {
    Bool(bool),
    Integer(i64),
    String(String),
    ListInt(Vec<i64>),
    Float(f64),
    ListFloat(Vec<f64>),
    ListString(Vec<String>),
    Timestamp(DateTime<Utc>),
}

A typed metadata parameter sent as part of output messages.

Parameters are stored by key in MetadataParameters. The get_*_param helpers (get_string_param, get_integer_param, get_bool_param) are type-checked: they return the value only when the stored variant matches the requested type, and None both for a missing key and for a key whose stored value has a different type. Callers therefore never need to match on the variant themselves for the common scalar cases.

use dora_message::metadata::{
    get_integer_param, get_string_param, MetadataParameters, Parameter,
};

let mut params = MetadataParameters::new();
params.insert("frame".to_string(), Parameter::Integer(7));

// Matching type -> the value.
assert_eq!(get_integer_param(&params, "frame"), Some(7));
// Wrong requested type -> None (not a panic, not a coercion).
assert_eq!(get_string_param(&params, "frame"), None);
// Missing key -> None.
assert_eq!(get_integer_param(&params, "absent"), None);

Variants

Bool(bool)

A boolean value.

Integer(i64)

A signed 64-bit integer value.

String(String)

A UTF-8 string value.

ListInt(Vec<i64>)

A list of signed 64-bit integers.

Float(f64)

A 64-bit floating-point value.

ListFloat(Vec<f64>)

A list of 64-bit floating-point values.

ListString(Vec<String>)

A list of UTF-8 strings.

Timestamp(DateTime<Utc>)

A UTC timestamp.

Trait Implementations

impl Clone for Parameter

fn clone(&self) -> Parameter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Parameter

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Parameter

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Parameter

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Parameter

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Parameter