Struct TdfFrameReader 

pub struct TdfFrameReader(/* private fields */);

A concrete frame reader for Bruker TDF files.

Thin newtype around timsrust_core::FrameReader<TdfIonReader, FrameInfoReader>. All [FrameReader] methods (get_frame, get_info, iter_indices, parallel_filter, …) are available via [Deref].

Implementations

impl TdfFrameReader

pub fn new(path: impl TDFPathLike) -> Result<Self, FrameReaderError>

pub fn without_metadata( path: impl TDFPathLike, compression_type: u8, max_peaks_per_scan: usize, ) -> Result<Self, FrameReaderError>

pub fn into_inner(self) -> FrameReader<TdfIonReader, FrameInfoReader>

Consume self and return the underlying generic timsrust_core::FrameReader.

pub fn get_acquisition(&self) -> AcquisitionType

Return the acquisition type detected from the frame metadata.

Methods from Deref<Target = FrameReader<TdfIonReader, FrameInfoReader>>

pub fn ion_reader(&self) -> &IonReader

pub fn info_reader(&self) -> &InfoReader

pub fn ion_reader_index(&self, index: usize) -> Result<usize, FrameReaderError>

pub fn info_reader_index(&self, index: usize) -> Result<usize, FrameReaderError>

pub fn get_ions(&self, index: usize) -> Result<FrameIons, FrameReaderError>

pub fn get_info(&self, index: usize) -> Result<FrameInfo, FrameReaderError>

pub fn get_frame(&self, index: usize) -> Result<Frame, FrameReaderError>

pub fn get_partial_frame_without_ions( &self, index: usize, ) -> Result<Frame, FrameReaderError>

Return a Frame populated with only FrameInfo (no ion data loaded).

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn iter_indices(&self) -> impl Iterator<Item = usize>

pub fn filter<'a, F>( &'a self, predicate: F, ) -> impl Iterator<Item = Result<Frame, FrameReaderError>>

where F: Fn(&Frame) -> bool + Sync + Send + 'a,

pub fn parallel_filter<'a, F>( &'a self, predicate: F, ) -> impl ParallelIterator<Item = Result<Frame, FrameReaderError>> + 'a

where F: Fn(&Frame) -> bool + Sync + Send + 'a, FrameReader<IonReader, InfoReader>: Sync + Send + 'a,

Trait Implementations

impl Debug for TdfFrameReader

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

Formats the value using the given formatter.

impl Deref for TdfFrameReader

type Target = FrameReader<TdfIonReader, FrameInfoReader>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.