Struct Param

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

A controlled vocabulary or user parameter

Fields

name: String

value: Value

accession: Option<u32>

controlled_vocabulary: Option<ControlledVocabulary>

unit: Unit

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.

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

where K: Into<String>, V: Into<Value>,

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

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

where T: FromStr,

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, A>(self, accession: S, name: A) -> Param

where S: AsRef<str>, A: AsRef<str>,

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

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

Update Param::unit from unit

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<(), Error>

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<(), Error>

Formats the value using the given formatter.

impl From<&DetectorTypeTerm> for Param

fn from(value: &DetectorTypeTerm) -> Param

Converts to this type from the input type.

impl From<&DissociationEnergyTerm> for Param

fn from(value: &DissociationEnergyTerm) -> Param

Converts to this type from the input type.

impl From<&DissociationMethodTerm> for Param

fn from(value: &DissociationMethodTerm) -> Param

Converts to this type from the input type.

impl From<&InletTypeTerm> for Param

fn from(value: &InletTypeTerm) -> Param

Converts to this type from the input type.

impl From<&IonizationTypeTerm> for Param

fn from(value: &IonizationTypeTerm) -> Param

Converts to this type from the input type.

impl From<&MassAnalyzerTerm> for Param

fn from(value: &MassAnalyzerTerm) -> Param

Converts to this type from the input type.

impl From<&MassSpectrometerFileFormatTerm> for Param

fn from(value: &MassSpectrometerFileFormatTerm) -> Param

Converts to this type from the input type.

impl From<&NativeSpectrumIdentifierFormatTerm> for Param

fn from(value: &NativeSpectrumIdentifierFormatTerm) -> Param

Converts to this type from the input type.

impl From<&SoftwareTerm> for Param

fn from(value: &SoftwareTerm) -> Param

Converts to this type from the input type.

impl From<DataProcessingAction> for Param

fn from(value: DataProcessingAction) -> Param

Converts to this type from the input type.

impl From<DetectorTypeTerm> for Param

fn from(value: DetectorTypeTerm) -> Param

Converts to this type from the input type.

impl From<DissociationEnergyTerm> for Param

fn from(value: DissociationEnergyTerm) -> Param

Converts to this type from the input type.

impl From<DissociationMethodTerm> for Param

fn from(value: DissociationMethodTerm) -> Param

Converts to this type from the input type.

impl From<FormatConversion> for Param

fn from(value: FormatConversion) -> Param

Converts to this type from the input type.

impl From<InletTypeTerm> for Param

fn from(value: InletTypeTerm) -> Param

Converts to this type from the input type.

impl From<IonizationTypeTerm> for Param

fn from(value: IonizationTypeTerm) -> Param

Converts to this type from the input type.

impl From<MassAnalyzerTerm> for Param

fn from(value: MassAnalyzerTerm) -> Param

Converts to this type from the input type.

impl From<MassSpectrometerFileFormatTerm> for Param

fn from(value: MassSpectrometerFileFormatTerm) -> Param

Converts to this type from the input type.

impl From<NativeSpectrumIdentifierFormatTerm> for Param

fn from(value: NativeSpectrumIdentifierFormatTerm) -> Param

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<SoftwareTerm> for Param

fn from(value: SoftwareTerm) -> Param

Converts to this type from the input type.

impl Hash for Param

fn hash<H>(&self, state: &mut H)

where H: Hasher,

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

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

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

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

fn unit(&self) -> Unit

fn is_ms(&self) -> bool

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

where T: FromStr,

fn is_controlled(&self) -> bool

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

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>(&self) -> Result<T, <T as FromStr>::Err>

where T: FromStr,

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_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<CURIE> for Param

fn eq(&self, other: &CURIE) -> 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 PartialEq<Param> for ParamCow<'_>

fn eq(&self, other: &Param) -> 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<'a> PartialEq<ParamCow<'a>> for Param

fn eq(&self, other: &ParamCow<'a>) -> 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 PartialEq for Param

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

type Error = String

The type returned in the event of a conversion error.

fn try_from(value: &Param) -> Result<CURIE, <CURIE as TryFrom<&Param>>::Error>

Performs the conversion.

impl TryFrom<MassSpectrometryFormat> for Param

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from( value: MassSpectrometryFormat, ) -> Result<Param, <Param as TryFrom<MassSpectrometryFormat>>::Error>

Performs the conversion.

impl Eq for Param

impl StructuralPartialEq for Param