Struct FileMetadataConfig 

pub struct FileMetadataConfig { /* private fields */ }

A helper data structure for implementing MSDataFileMetadata in a single common implementation.

Implementations

impl FileMetadataConfig

pub fn new( file_description: FileDescription, instrument_configurations: HashMap<u32, InstrumentConfiguration>, softwares: Vec<Software>, samples: Vec<Sample>, scan_settings: Vec<ScanSettings>, data_processings: Vec<DataProcessing>, run: MassSpectrometryRun, num_spectra: Option<u64>, ) -> FileMetadataConfig

Trait Implementations

impl Clone for FileMetadataConfig

fn clone(&self) -> FileMetadataConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileMetadataConfig

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

Formats the value using the given formatter.

impl Default for FileMetadataConfig

fn default() -> FileMetadataConfig

Returns the “default value” for a type.

impl<T> From<&T> for FileMetadataConfig

where T: MSDataFileMetadata,

fn from(value: &T) -> FileMetadataConfig

Converts to this type from the input type.

impl MSDataFileMetadata for FileMetadataConfig

fn data_processings(&self) -> &Vec<DataProcessing>

The series of DataProcessing workflows applied to spectra in this data file.

fn instrument_configurations(&self) -> &HashMap<u32, InstrumentConfiguration>

A mapping over different InstrumentConfiguration modes that spectra were acquired under.

fn file_description(&self) -> &FileDescription

A description of the contents and the sources for this mass spectrometry data file.

fn softwares(&self) -> &Vec<Software>

The series of Software applied to the data file to apply different DataProcessing methods.

fn data_processings_mut(&mut self) -> &mut Vec<DataProcessing>

Mutably access the DataProcessing list for this data file

fn instrument_configurations_mut( &mut self, ) -> &mut HashMap<u32, InstrumentConfiguration>

Mutably access the InstrumentConfiguration mapping for this data file

fn file_description_mut(&mut self) -> &mut FileDescription

Mutably access the FileDescription description of the contents and the sources for this mass spectrometry data file.

fn softwares_mut(&mut self) -> &mut Vec<Software>

Mutably access the list of Software of this data file.

fn samples(&self) -> &Vec<Sample>

A list of sample descriptions that were measured in this data file if available.

fn samples_mut(&mut self) -> &mut Vec<Sample>

fn scan_settings(&self) -> Option<&Vec<ScanSettings>>

A list of scan settings in ScanSettings pre-configured by the instrument operator prior to the start of data acquisition.

fn scan_settings_mut(&mut self) -> Option<&mut Vec<ScanSettings>>

Mutably access the list of ScanSettings for this dataset. Most formats do not possess a related concept and will not carry one.

fn run_description(&self) -> Option<&MassSpectrometryRun>

Access the MassSpectrometryRun metadata record if it is available

fn run_description_mut(&mut self) -> Option<&mut MassSpectrometryRun>

Mutably access the MassSpectrometryRun metadata record if it is available

fn set_spectrum_count_hint(&mut self, _value: Option<u64>)

fn spectrum_count_hint(&self) -> Option<u64>

A hint about how many spectra are in this data file

fn copy_metadata_from(&mut self, source: &impl MSDataFileMetadata)

where Self: Sized,

Copy the metadata from another MSDataFileMetadata implementation into this one.

fn source_file_name(&self) -> Option<&str>

Get the name of the primary source file, if available