Trait BuildArrayMapFrom

Source

pub trait BuildArrayMapFrom: Sized {
    // Required method
    fn as_arrays(source: &[Self]) -> BinaryArrayMap;

    // Provided method
    fn arrays_included(&self) -> Option<Vec<ArrayType>> { ... }
}

Expand description

A trait for converting a slice of peaks or features into a BinaryArrayMap.

This is the inverse of BuildFromArrayMap.

§Examples

use mzpeaks::CentroidPeak;
use mzdata_bindata::{ArrayType, BuildArrayMapFrom, BuildFromArrayMap};

let peaks = vec![
    CentroidPeak::new(500.0, 1200.0, 0),
    CentroidPeak::new(750.5, 800.0, 1),
];

let arrays = CentroidPeak::as_arrays(&peaks);
assert!(arrays.has_array(&ArrayType::MZArray));
assert!(arrays.has_array(&ArrayType::IntensityArray));

let roundtripped = CentroidPeak::try_from_arrays(&arrays).unwrap();
assert_eq!(roundtripped.len(), 2);
assert_eq!(roundtripped[0].mz, 500.0);

Required Methods§

Source

fn as_arrays(source: &[Self]) -> BinaryArrayMap

Serialize a slice of Self into a BinaryArrayMap.

This assumes that the operation cannot fail as all the data is available in memory already.

Provided Methods§

Source

fn arrays_included(&self) -> Option<Vec<ArrayType>>

The ArrayType produced by this peak type when converted.

The default implementation returns None.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types§

Source §

It uses a non-standard “feature identifier array” which assigns a unique integer identifier to all points belonging to the same Feature.

It also produces ArrayType::RawIonMobilityArray which does not have an associated Unit. The caller should update this if context is available.

Source §

fn arrays_included(&self) -> Option<Vec<ArrayType>>

ChargedFeature produces ArrayType::MZArray, ArrayType::ChargeArray, ArrayType::IntensityArray, ArrayType::RawIonMobilityArray, and a non-standard “feature identifier array”

Source §

fn as_arrays(source: &[ChargedFeature<Mass, IonMobility>]) -> BinaryArrayMap

ChargedFeature uses a non-standard “feature identifier array” which assigns a unique integer identifier to all points belonging to the same ChargedFeature.

Like DeconvolutedPeak, ChargedFeature will compute its m/z value from neutral mass and charge, and assumes that the charge carrier is a proton.

It also produces ArrayType::RawIonMobilityArray which does not have an associated Unit. The caller should update these for consistency

Source §

impl BuildArrayMapFrom for DeconvolutedPeak

The basic DeconvolutedPeak implements BuildArrayMapFrom.

It produces the much more common ArrayType::MZArray instead of [ArrayType::MassArray] for compatibility with other tools, and assumes that the charge carrier is a proton.

Source §