Struct mzdata::meta::FileDescription

pub struct FileDescription {
    pub contents: ParamList,
    pub source_files: Vec<SourceFile>,
}

A description of the file data file and its contents

Fields

contents: ParamList

Descriptors of the content spectra

source_files: Vec<SourceFile>

Any source files involved in producing the current file, such as vendor raw files.

Implementations

impl FileDescription

pub fn new(contents: ParamList, source_files: Vec<SourceFile>) -> Self

pub fn has_ms1_spectra(&self) -> bool

Checks to see if the “MS1 spectrum” term is present in the file contents

Note: This does not actually inspect the spectra in the file, only the metadata, which may be incorrect/missing.

pub fn has_msn_spectra(&self) -> bool

Checks to see if the “MSn spectrum” term is present in the file contents.

Note: This does not actually inspect the spectra in the file, only the metadata, which may be incorrect/missing.

pub fn has_contents(&self) -> bool

Trait Implementations

impl Clone for FileDescription

fn clone(&self) -> FileDescription

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileDescription

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

Formats the value using the given formatter.

impl Default for FileDescription

fn default() -> FileDescription

Returns the “default value” for a type.

impl ParamDescribed for FileDescription

fn params(&self) -> &[Param]

Obtain an immutable slice over the encapsulated Param list

fn params_mut(&mut self) -> &mut ParamList

Obtain an mutable slice over the encapsulated Param list

fn add_param(&mut self, param: Param)

Add a new Param to the entity

fn extend_params(&mut self, it: impl IntoIterator<Item = Param>)

Add all parameters from an iterator of Param to the entity

fn remove_param(&mut self, index: usize) -> Param

Remove the ith Param from the entity.

fn get_param_by_name(&self, name: &str) -> Option<&Param>

Find the first Param whose name matches name

fn get_param_by_curie(&self, curie: &CURIE) -> Option<&Param>

Find the first Param whose CURIE matches curie

fn get_param_by_accession(&self, accession: &str) -> Option<&Param>

Find the first Param whose Param::accession matches accession

fn iter_params(&self) -> Iter<'_, Param>

Iterate over the encapsulated parameter list

fn iter_params_mut(&mut self) -> IterMut<'_, Param>

Iterate mutably over the encapsulated parameter list

impl PartialEq for FileDescription

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

impl StructuralPartialEq for FileDescription