Struct FileDescription 

pub struct FileDescription { /* private fields */ }

A wrapper around the FileDescription FlatBuffer schema. It mirrors the data stored there-in.

It describes the contents of the RAW file and a small amount information about how it was created.

Implementations

impl FileDescription

pub fn new(data: RawVec<u8>) -> Self

pub fn check(&self) -> bool

Check that the buffer is a valid FileDescriptionT

pub fn view(&self) -> FileDescriptionT<'_>

View the underlying buffer as a FileDescriptionT

pub fn sample_id(&self) -> Option<&str>

The sample identifier provided by the user, if one is present

pub fn sample_vial(&self) -> Option<&str>

The sample vial name provided by the user or sample handling system, if present

pub fn sample_comment(&self) -> Option<&str>

The comment describing the sample as provided by the user, if present

pub fn sample_name(&self) -> Option<&str>

The sample name provided by the user, if one is present

pub fn source_file(&self) -> Option<&str>

The name of the RAW file being described, as it was recorded by the control software

pub fn creation_date(&self) -> Option<&str>

The date the RAW file was created, or that the instrument run was performed

pub fn spectra_per_ms_level(&self) -> Option<Vector<'_, u32>>

The number of spectra at MS levels 1-10.

This returns a flatbuffers::Vector of counts where index i corresponds to the number of MS level i+1 spectra in the RAW file.

pub fn trailer_headers(&self) -> Option<Vector<'_, ForwardsUOffset<&str>>>

Trailer headers for the RAW file.