Struct ConvertOptions 

#[non_exhaustive]
pub struct ConvertOptions {
    pub indexed: bool,
    pub centroid: bool,
    pub centroid_min_intensity: Option<f32>,
    pub write: WriteOptions,
}

Options for convert_to_mzml and convert_to_mzml_writer.

The defaults write un-indexed mzML with zlib-compressed arrays, no centroiding, and stop at the first unreadable record.

use openmassspec_io::core::RecordErrorPolicy;
use openmassspec_io::ConvertOptions;

let opts = ConvertOptions::new()
    .with_indexed(true)
    .with_centroid(true)
    .with_record_error_policy(RecordErrorPolicy::Skip);
assert!(opts.indexed);

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

indexed: bool

Emit indexed mzML (<indexList> and <fileChecksum>).

centroid: bool

Centroid every profile-mode spectrum before writing (local-maxima peak picking; already-centroided spectra pass through unchanged).

centroid_min_intensity: Option<f32>

When centroiding, discard picked peaks below this intensity. Ignored unless centroid is set.

write: WriteOptions

Writer options from openmassspec-core: binary array compression and the record-error policy.

Implementations

impl ConvertOptions

pub fn new() -> Self

Default options (see the type-level docs).

pub fn with_indexed(self, indexed: bool) -> Self

Emit indexed mzML.

pub fn with_centroid(self, centroid: bool) -> Self

Centroid profile-mode spectra before writing.

pub fn with_centroid_min_intensity( self, min_intensity: impl Into<Option<f32>>, ) -> Self

Noise floor for centroiding.

pub fn with_compression(self, compression: Compression) -> Self

Binary data array compression.

pub fn with_record_error_policy(self, policy: RecordErrorPolicy) -> Self

What to do with a spectrum or chromatogram the reader cannot decode. RecordErrorPolicy::Fail (the default) stops and returns the error; RecordErrorPolicy::Skip leaves it out and counts it in the returned WriteSummary.

pub fn with_write_options(self, write: WriteOptions) -> Self

Replace the writer options wholesale.

Trait Implementations

impl Clone for ConvertOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConvertOptions

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

Formats the value using the given formatter.

impl Default for ConvertOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for ConvertOptions

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ConvertOptions