Skip to main content

PairedFastqReader

Struct PairedFastqReader 

Source
pub struct PairedFastqReader<R1, R2> { /* private fields */ }
Expand description

Stateful reader for ordered separate-file paired-end FASTQ streams.

This reader validates matching records as it advances both streams. It does not reorder or synchronize mates that appear in different orders.

Implementations§

Source§

impl<R1: Read, R2: Read> PairedFastqReader<R1, R2>

Source

pub fn new(first: R1, second: R2) -> Self

Create a paired reader with default FASTQ configuration.

Source

pub fn with_config(first: R1, second: R2, config: FastqConfig) -> Self

Create a paired reader using the same configuration for both streams.

Source

pub fn with_configs( first: R1, first_config: FastqConfig, second: R2, second_config: FastqConfig, ) -> Self

Create a paired reader with separate per-stream configurations.

Source

pub fn from_fastq_readers( first: FastqReader<R1>, second: FastqReader<R2>, ) -> Self

Create a paired reader from two existing FastqReader values.

Source

pub fn with_pair_validation(self, pair_validation: PairValidation) -> Self

Override the paired identifier validation policy.

Source

pub fn next_pair_batch(&mut self) -> Result<Option<PairedFastqBatch<'_>>>

Read the next validated paired batch.

Returns Ok(None) when both streams end together.

Trait Implementations§

Source§

impl<R1: Debug, R2: Debug> Debug for PairedFastqReader<R1, R2>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<R1, R2> Freeze for PairedFastqReader<R1, R2>
where R1: Freeze, R2: Freeze,

§

impl<R1, R2> RefUnwindSafe for PairedFastqReader<R1, R2>

§

impl<R1, R2> Send for PairedFastqReader<R1, R2>
where R1: Send, R2: Send,

§

impl<R1, R2> Sync for PairedFastqReader<R1, R2>
where R1: Sync, R2: Sync,

§

impl<R1, R2> Unpin for PairedFastqReader<R1, R2>
where R1: Unpin, R2: Unpin,

§

impl<R1, R2> UnsafeUnpin for PairedFastqReader<R1, R2>
where R1: UnsafeUnpin, R2: UnsafeUnpin,

§

impl<R1, R2> UnwindSafe for PairedFastqReader<R1, R2>
where R1: UnwindSafe, R2: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.