Struct Param 

pub struct Param {
    pub name: String,
    pub value: Value,
    pub accession: Option<AccessionIntCode>,
    pub controlled_vocabulary: Option<ControlledVocabulary>,
    pub unit: Unit,
}

A controlled vocabulary or user parameter

Fields

name: String

The human-readable name of the parameter.

value: Value

A type generic value associated with the parameter

accession: Option<AccessionIntCode>

The numeric component of the accession code in the identifier for the parameter’s definition in Self::controlled_vocabulary, if it is defined by one.

controlled_vocabulary: Option<ControlledVocabulary>

The controlled vocabulary this parameter is defined in, if any.

unit: Unit

The unit the parameter’s value is expressed in, if any.

Implementations

impl Param

pub fn new() -> Param

Create a new, empty Param.

See also

• Param::new_key_value
• Param::builder
• ControlledVocabulary::param
• ControlledVocabulary::param_val

pub fn builder() -> ParamBuilder

Create a new ParamBuilder to make creating a new Param more convenient than setting fields on a bare Param directly.

pub fn new_key_value<K: Into<String>, V: Into<Value>>( name: K, value: V, ) -> Param

A construction method for Param that sets Param::name and Param::value but leaves all other attributes as default.

pub fn parse<T: FromStr>(&self) -> Result<T, T::Err>

Attempt to parse the value of this parameter into T.

See Value::parse

pub const fn is_controlled(&self) -> bool

Check if this parameter is defined in a controlled vocabulary

pub const fn curie(&self) -> Option<CURIE>

Create a CURIE from Param::controlled_vocabulary and Param::accession

pub fn curie_str(&self) -> Option<String>

Format the Param::curie as a string, if it exists

pub fn with_unit<S: AsRef<str>, A: AsRef<str>>( self, accession: S, name: A, ) -> Param

Update Param::unit inferred from accession, failing that, name

See also

• Param::with_unit_t, to infer the unit from a resolved Unit

pub fn with_unit_t(self, unit: &Unit) -> Param

Set Param::unit directly from unit.

See also

• Param::with_unit, to infer the unit from an accession or name instead

Trait Implementations

impl AsRef<Value> for Param

fn as_ref(&self) -> &Value

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Param

fn clone(&self) -> Param

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Param

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

Formats the value using the given formatter.

impl Default for Param

fn default() -> Param

Returns the “default value” for a type.

impl Display for Param

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

Formats the value using the given formatter.

impl Eq for Param

impl<'a> From<ParamCow<'a>> for Param

fn from(value: ParamCow<'a>) -> Self

Converts to this type from the input type.

impl Hash for Param

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 ParamLike for Param

fn name(&self) -> &str

The human-readable name of the parameter.

fn value(&self) -> ValueRef<'_>

A borrowed view of the parameter’s value.

fn accession(&self) -> Option<AccessionIntCode>

The numeric accession code within ParamLike::controlled_vocabulary, if this parameter is drawn from a controlled vocabulary.

fn controlled_vocabulary(&self) -> Option<ControlledVocabulary>

The controlled vocabulary this parameter’s term belongs to, if any.

fn unit(&self) -> Unit

The unit the parameter’s value is expressed in, if known.

fn is_ms(&self) -> bool

Check whether this parameter’s term belongs to the PSI-MS controlled vocabulary.

fn parse<T: FromStr>(&self) -> Result<T, T::Err>

Parse the parameter’s value as T. See ParamValue::parse.

fn is_controlled(&self) -> bool

Check whether this parameter is drawn from a controlled vocabulary, as opposed to being a free-text user-defined parameter.

fn curie(&self) -> Option<CURIE>

Build a CURIE from ParamLike::controlled_vocabulary and ParamLike::accession, if both are present.

impl ParamValue for Param

fn is_empty(&self) -> bool

Check if the value is empty

fn is_i64(&self) -> bool

Check if the value is an integer

fn is_f64(&self) -> bool

Check if the value is a floating point number explicitly. An integral number might still be usable as a floating point number

fn is_buffer(&self) -> bool

Check if the value is an arbitrary buffer

fn is_str(&self) -> bool

Check if the value is stored as an explicit string. All variants can be coerced to a string.

fn to_f64(&self) -> Result<f64, ParamValueParseError>

Get the value as an f64, if possible

fn to_i64(&self) -> Result<i64, ParamValueParseError>

Get the value as an i64, if possible

fn to_str(&self) -> Cow<'_, str>

Get the value as a string

fn to_buffer(&self) -> Result<Cow<'_, [u8]>, ParamValueParseError>

Get the value as a byte buffer, if possible.

fn parse<T: FromStr>(&self) -> Result<T, T::Err>

Convert the value’s string representation to T if possible

fn as_bytes(&self) -> Cow<'_, [u8]>

Convert the value to a byte string, the bytes of the string representation.

fn as_ref(&self) -> ValueRef<'_>

Get a reference to the stored value

fn data_len(&self) -> usize

Get the size of the stored data type

fn is_boolean(&self) -> bool

Check if the value is a boolean

fn to_bool(&self) -> Result<bool, ParamValueParseError>

Get the value as a bool, if possible

fn is_list(&self) -> bool

Check if the value is a list

fn as_slice(&self) -> Cow<'_, [Value]>

Get the value as a slice

fn is_numeric(&self) -> bool

Check if the value is of either numeric type.

fn to_f32(&self) -> Result<f32, ParamValueParseError>

Get the value as an f32, if possible

fn to_i32(&self) -> Result<i32, ParamValueParseError>

Get the value as an i32, if possible

fn to_u64(&self) -> Result<u64, ParamValueParseError>

Get the value as an u64, if possible

fn as_str(&self) -> Cow<'_, str>

Get the value as a string, possibly borrowed

impl PartialEq for Param

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<CURIE> for Param

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<Param> for ParamCow<'_>

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

Equality operator ==.

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

Inequality operator !=.

impl<'a> PartialEq<ParamCow<'a>> for Param

fn eq(&self, other: &ParamCow<'a>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Param

impl TryFrom<&Param> for CURIE

type Error = String

The type returned in the event of a conversion error.

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

Performs the conversion.