Struct MZReaderBuilder

pub struct MZReaderBuilder<C = CentroidPeak, D = DeconvolutedPeak>
where
    C: CentroidLike + From<CentroidPeak> + BuildFromArrayMap,
    D: DeconvolutedCentroidLike + From<DeconvolutedPeak> + BuildFromArrayMap,
{ /* private fields */ }

A builder type for MZReaderType.

To create an instance, see MZReaderType::builder

Implementations

impl<C, D> MZReaderBuilder<C, D>

where C: CentroidLike + From<CentroidPeak> + BuildFromArrayMap, D: DeconvolutedCentroidLike + From<DeconvolutedPeak> + BuildFromArrayMap,

pub fn buffer_size(self, capacity: usize) -> MZReaderBuilder<C, D>

Set the buffer capacity for a streaming reader.

pub fn detail_level(self, detail_level: DetailLevel) -> MZReaderBuilder<C, D>

Set the detail level for controlling how much work the reader will do to load peak information from spectra.

pub fn from_path<P>(self, path: P) -> Result<MZReaderType<File, C, D>, Error>

where P: AsRef<Path>,

Create a reader from a file on the local file system denoted by path.

pub fn from_read_seek<R>( self, source: R, ) -> Result<MZReaderType<R, C, D>, Error>

where R: Read + Seek,

Create a reader from a type that supports io::Read and io::Seek.

Note

Not all formats can be read from an io type, these will fail to open and an error will be returned

pub fn from_read<R>( self, source: R, ) -> Result<StreamingSpectrumIterator<C, D, MultiLayerSpectrum<C, D>, MZReaderType<PreBufferedStream<R>, C, D>>, Error>

where R: Read,

Create a reader from a type that supports io::Read.

This will internally wrap the file in a PreBufferedStream for metadata reading, but does not construct an index for full random access. Attempting to use the reader to access spectra may move the reader forwards, but it can never go backwards.

Note

Not all formats can be read from an io type, these will fail to open and an error will be returned

Trait Implementations

impl<C, D> Debug for MZReaderBuilder<C, D>

where C: Debug + CentroidLike + From<CentroidPeak> + BuildFromArrayMap, D: Debug + DeconvolutedCentroidLike + From<DeconvolutedPeak> + BuildFromArrayMap,

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

Formats the value using the given formatter.

impl<C, D> Default for MZReaderBuilder<C, D>

where C: CentroidLike + From<CentroidPeak> + BuildFromArrayMap, D: DeconvolutedCentroidLike + From<DeconvolutedPeak> + BuildFromArrayMap,

fn default() -> MZReaderBuilder<C, D>

Returns the “default value” for a type.