Enum mzdata::params::ControlledVocabulary

pub enum ControlledVocabulary {
    MS,
    UO,
    Unknown,
}

Controlled vocabularies used in mass spectrometry data files

Variants

MS

The PSI-MS Controlled Vocabulary https://www.ebi.ac.uk/ols4/ontologies/ms

UO

The Unit Ontology https://www.ebi.ac.uk/ols4/ontologies/uo

Unknown

Implementations

impl<'a> ControlledVocabulary

pub const fn prefix(&self) -> Cow<'static, str>

Get the CURIE namespace prefix for this controlled vocabulary

pub const fn as_bytes(&self) -> &'static [u8]

Like ControlledVocabulary::prefix, but obtain a byte string instead

pub const fn as_option(&self) -> Option<Self>

pub fn param<A: Into<AccessionLike<'a>>, S: Into<String>>( &self, accession: A, name: S, ) -> Param

Create a Param whose accession comes from this controlled vocabulary namespace with an empty value.

Arguments

• accession: The accession code for the Param. If specified as a CURIE or a string-like type, any namespace is ignored.
• name: The name of the parameter

See Also

• ControlledVocabulary::param_val

pub const fn curie(&self, accession: u32) -> CURIE

pub const fn const_param( &self, name: &'static str, value: ValueRef<'static>, accession: u32, unit: Unit, ) -> ParamCow<'static>

Create a ParamCow from this namespace in a const context, useful for preparing global constants or inlined variables.

All parameters must have a 'static lifetime.

Arguments

• name: The name of the controlled vocabulary term.
• value: The wrapped value as a constant.
• accession: The a priori determined accession code for the term
• unit: The unit associated with the value

pub const fn const_param_ident( &self, name: &'static str, accession: u32, ) -> ParamCow<'static>

Create a ParamCow from this namespace in a const context with an empty value and no unit.

See ControlledVocabulary::const_param for more details.

pub const fn const_param_ident_unit( &self, name: &'static str, accession: u32, unit: Unit, ) -> ParamCow<'static>

Create a ParamCow from this namespace in a const context with an empty value but a specified unit.

This is intended to create a “template” that will be copied and have a value specified.

See ControlledVocabulary::const_param for more details.

pub fn param_val<S: Into<String>, A: Into<AccessionLike<'a>>, V: Into<Value>>( &self, accession: A, name: S, value: V, ) -> Param

Create a Param whose accession comes from this controlled vocabulary namespace with the given value.

Arguments

• accession: The accession code for the Param. If specified as a CURIE or a string-like type, any namespace is ignored.
• name: The name of the parameter
• value: The value of the parameter

See Also

• ControlledVocabulary::param

Trait Implementations

impl Clone for ControlledVocabulary

fn clone(&self) -> ControlledVocabulary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ControlledVocabulary

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

Formats the value using the given formatter.

impl FromStr for ControlledVocabulary

type Err = ControlledVocabularyResolutionError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for ControlledVocabulary

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 PartialEq for ControlledVocabulary

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ControlledVocabulary

impl Eq for ControlledVocabulary

impl StructuralPartialEq for ControlledVocabulary