Struct BinaryArrayMap

pub struct BinaryArrayMap {
    pub byte_buffer_map: HashMap<ArrayType, DataArray>,
}

A collection of DataArrays that are identified by name.

Fields

byte_buffer_map: HashMap<ArrayType, DataArray>

Implementations

impl BinaryArrayMap

pub fn new() -> BinaryArrayMap

pub fn len(&self) -> usize

Get the number of arrays in the map

pub fn is_empty(&self) -> bool

pub fn has_ion_mobility(&self) -> bool

Check if there is an ion mobility array present

pub fn iter(&self) -> Iter<'_, ArrayType, DataArray>

Iterate over references to the key-value pairs of this map

pub fn iter_mut(&mut self) -> IterMut<'_, ArrayType, DataArray>

Iterate over mutable references to the key-value pairs of this map

pub fn encode_array( &mut self, array_type: &ArrayType, compression: BinaryCompressionType, ) -> Result<(), ArrayRetrievalError>

Compress a specific DataArray with the compression scheme provided, if it is present.

This method may fail if the compression fails or if the array type is missing.

See Also

DataArray::store_compressed

pub fn decode_all_arrays(&mut self) -> Result<(), ArrayRetrievalError>

Decode all DataArray in this map if they have not been decoded already so that they are ready for use. If there are many arrays and the parallelism feature is enabled, arrays may be decoded in parallel.

pub fn decode_array( &mut self, array_type: &ArrayType, ) -> Result<(), ArrayRetrievalError>

Decode a specific DataArray if it is present.

This method may fail if decoding fails or if the array type is missing.

pub fn add(&mut self, array: DataArray)

Add a DataArray to the map by its ArrayType name

pub fn get(&self, array_type: &ArrayType) -> Option<&DataArray>

Get a reference to a specific DataArray if present

pub fn get_mut(&mut self, array_type: &ArrayType) -> Option<&mut DataArray>

Get a mutable reference to a specific DataArray if present

pub fn has_array(&self, array_type: &ArrayType) -> bool

Check whether a specific ArrayType is present

pub fn clear(&mut self)

Clear the map, discarding any array data

pub fn search(&self, query: f64, error_tolerance: Tolerance) -> Option<usize>

Search for a specific m/z

pub fn mzs(&self) -> Result<Cow<'_, [f64]>, ArrayRetrievalError>

Get a reference to the m/z array if it is present

pub fn mzs_mut(&mut self) -> Result<&mut [f64], ArrayRetrievalError>

Get a mutable reference to the m/z array if it is present

pub fn intensities(&self) -> Result<Cow<'_, [f32]>, ArrayRetrievalError>

Get a reference to the intensity array if it is present

pub fn intensities_mut(&mut self) -> Result<&mut [f32], ArrayRetrievalError>

Get a mutable reference to the intensity array if it is present

pub fn charges(&self) -> Result<Cow<'_, [i32]>, ArrayRetrievalError>

Get a reference to the charge array if it is present

pub fn charge_mut(&mut self) -> Result<&mut [i32], ArrayRetrievalError>

Get a mutable reference to the charge array if it is present

pub fn ion_mobility( &self, ) -> Result<(Cow<'_, [f64]>, ArrayType), ArrayRetrievalError>

Get a reference to the ion mobility array if it is present

pub fn ion_mobility_mut( &mut self, ) -> Result<(&mut [f64], ArrayType), ArrayRetrievalError>

Get a mutable reference to the ion mobility array if it is present

pub fn stack_ion_mobility(self) -> Result<BinaryArrayMap3D, ArrayRetrievalError>

Split an array map along the ion mobility dimension if it is present.

This function will fail if there is no ion mobility dimension.

Trait Implementations

impl Clone for BinaryArrayMap

fn clone(&self) -> BinaryArrayMap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BinaryArrayMap

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

Formats the value using the given formatter.

impl Default for BinaryArrayMap

fn default() -> BinaryArrayMap

Returns the “default value” for a type.

impl<C> From<&BinaryArrayMap> for PeakSetVec<C, MZ>

where C: CentroidLike + From<CentroidPeak>,

fn from(arrays: &BinaryArrayMap) -> PeakSetVec<C, MZ>

Converts to this type from the input type.

impl From<&BinaryArrayMap> for PeakSetVec<DeconvolutedPeak, Mass>

fn from(arrays: &BinaryArrayMap) -> PeakSetVec<DeconvolutedPeak, Mass>

Converts to this type from the input type.

impl From<&PeakSetVec<CentroidPeak, MZ>> for BinaryArrayMap

fn from(peaks: &PeakSetVec<CentroidPeak, MZ>) -> BinaryArrayMap

Converts to this type from the input type.

impl From<&PeakSetVec<DeconvolutedPeak, Mass>> for BinaryArrayMap

fn from(peaks: &PeakSetVec<DeconvolutedPeak, Mass>) -> BinaryArrayMap

Converts to this type from the input type.

impl<C> From<BinaryArrayMap> for PeakSetVec<C, MZ>

where C: CentroidLike + From<CentroidPeak>,

fn from(arrays: BinaryArrayMap) -> PeakSetVec<C, MZ>

Converts to this type from the input type.

impl IntoIterator for BinaryArrayMap

type Item = (ArrayType, DataArray)

The type of the elements being iterated over.

type IntoIter = <HashMap<ArrayType, DataArray> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> <BinaryArrayMap as IntoIterator>::IntoIter

Creates an iterator from a value.

impl TryFrom<&BinaryArrayMap> for BinaryArrayMap3D

type Error = ArrayRetrievalError

The type returned in the event of a conversion error.

fn try_from( value: &BinaryArrayMap, ) -> Result<BinaryArrayMap3D, <BinaryArrayMap3D as TryFrom<&BinaryArrayMap>>::Error>

Performs the conversion.

impl TryFrom<BinaryArrayMap> for BinaryArrayMap3D

type Error = ArrayRetrievalError

The type returned in the event of a conversion error.

fn try_from( value: BinaryArrayMap, ) -> Result<BinaryArrayMap3D, <BinaryArrayMap3D as TryFrom<BinaryArrayMap>>::Error>

Performs the conversion.