Struct WriteOptions 

#[non_exhaustive]
pub struct WriteOptions {
    pub compression: Compression,
    pub record_error_policy: RecordErrorPolicy,
    pub spool_dir: Option<PathBuf>,
}

Options for write_mzml_with_options and write_indexed_mzml_with_options.

use openmassspec_core::{Compression, RecordErrorPolicy, WriteOptions};

let opts = WriteOptions::new()
    .with_compression(Compression::NoCompression)
    .with_record_error_policy(RecordErrorPolicy::Skip);
assert_eq!(opts.record_error_policy, RecordErrorPolicy::Skip);

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.

compression: Compression

Binary-data-array codec. Defaults to Compression::Zlib.

record_error_policy: RecordErrorPolicy

Handling of Err records. Defaults to RecordErrorPolicy::Fail.

spool_dir: Option<PathBuf>

Directory for the temporary file that holds written spectra once they pass 64 MiB (see write_mzml_with_options). None, the default, uses std::env::temp_dir.

Implementations

impl WriteOptions

pub fn new() -> Self

Default options: zlib compression, stop at the first record error.

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

Set the binary-data-array codec.

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

Set the record-error policy.

pub fn with_spool_dir(self, dir: impl Into<PathBuf>) -> Self

Set the directory for the spectrum spool file.

Trait Implementations

impl Clone for WriteOptions

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 WriteOptions

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

Formats the value using the given formatter.

impl Default for WriteOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for WriteOptions

impl PartialEq for WriteOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for WriteOptions