Enum ParameterValue

pub enum ParameterValue {
    Bool(bool),
    Integer(i64),
    Double(f64),
    String(Arc<str>),
    ByteArray(Arc<[u8]>),
    BoolArray(Arc<[bool]>),
    IntegerArray(Arc<[i64]>),
    DoubleArray(Arc<[f64]>),
    StringArray(Arc<[Arc<str>]>),
}

A parameter value.

Such a value can be specified in YAML format on the command line, or in a parameter file. For instance --param foo:='[1, 2, 3]' specfies an IntegerArray value for the foo parameter.

Variants

Bool(bool)

A boolean value.

YAML examples: true, True, yes, y.

Integer(i64)

An i64 value.

YAML examples: 1, -30, 0x7C.

Double(f64)

An f64 value.

YAML examples: 2.0, 8e-3.

String(Arc<str>)

A string.

YAML examples: "", "björk", "42".

Unquoted strings are also possible, but not recommended, because they may be interpreted as another data type.

ByteArray(Arc<[u8]>)

An array of u8.

YAML example: Not possible to specify as YAML.

BoolArray(Arc<[bool]>)

An array of booleans.

YAML example: [true, false, false].

IntegerArray(Arc<[i64]>)

An array of i64.

YAML example: [3, 4].

DoubleArray(Arc<[f64]>)

An array of f64.

YAML example: [5.0, 6e2].

StringArray(Arc<[Arc<str>]>)

An array of strings.

YAML example: ["abc", ""].

Trait Implementations

impl Clone for ParameterValue

fn clone(&self) -> ParameterValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ParameterValue

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

Formats the value using the given formatter.

impl From<Arc<[Arc<str>]>> for ParameterValue

fn from(value: Arc<[Arc<str>]>) -> ParameterValue

Converts to this type from the input type.

impl From<Arc<[bool]>> for ParameterValue

fn from(value: Arc<[bool]>) -> ParameterValue

Converts to this type from the input type.

impl From<Arc<[f64]>> for ParameterValue

fn from(value: Arc<[f64]>) -> ParameterValue

Converts to this type from the input type.

impl From<Arc<[i64]>> for ParameterValue

fn from(value: Arc<[i64]>) -> ParameterValue

Converts to this type from the input type.

impl From<Arc<[u8]>> for ParameterValue

fn from(value: Arc<[u8]>) -> ParameterValue

Converts to this type from the input type.

impl From<Arc<str>> for ParameterValue

fn from(value: Arc<str>) -> ParameterValue

Converts to this type from the input type.

impl From<bool> for ParameterValue

fn from(value: bool) -> ParameterValue

Converts to this type from the input type.

impl From<f64> for ParameterValue

fn from(value: f64) -> ParameterValue

Converts to this type from the input type.

impl From<i64> for ParameterValue

fn from(value: i64) -> ParameterValue

Converts to this type from the input type.

impl ParameterVariant for ParameterValue

type Range = ParameterRanges

The type used to describe the range of this parameter.

fn kind() -> ParameterKind

Returns the ParameterKind of the implemented type.

impl PartialEq for ParameterValue

fn eq(&self, other: &ParameterValue) -> 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 TryFrom<ParameterValue> for Arc<[Arc<str>]>

type Error = ParameterValueError

The type returned in the event of a conversion error.

fn try_from(value: ParameterValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ParameterValue> for Arc<[bool]>

type Error = ParameterValueError

The type returned in the event of a conversion error.

fn try_from(value: ParameterValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ParameterValue> for Arc<[f64]>

type Error = ParameterValueError

The type returned in the event of a conversion error.

fn try_from(value: ParameterValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ParameterValue> for Arc<[i64]>

type Error = ParameterValueError

The type returned in the event of a conversion error.

fn try_from(value: ParameterValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ParameterValue> for Arc<[u8]>

type Error = ParameterValueError

The type returned in the event of a conversion error.

fn try_from(value: ParameterValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ParameterValue> for Arc<str>

type Error = ParameterValueError

The type returned in the event of a conversion error.

fn try_from(value: ParameterValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ParameterValue> for bool

type Error = ParameterValueError

The type returned in the event of a conversion error.

fn try_from(value: ParameterValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ParameterValue> for f64

type Error = ParameterValueError

The type returned in the event of a conversion error.

fn try_from(value: ParameterValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ParameterValue> for i64

type Error = ParameterValueError

The type returned in the event of a conversion error.

fn try_from(value: ParameterValue) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for ParameterValue