Skip to main content

FastqConfig

Struct FastqConfig 

Source
pub struct FastqConfig {
    pub slab_size: usize,
    pub validate: bool,
    pub pairing: PairingMode,
    pub pair_validation: PairValidation,
}
Expand description

Configuration for FASTQ batch readers.

The default is a validated, unpaired reader with a 1 MiB slab and full pair identifier validation when pairing APIs are used.

Fields§

§slab_size: usize

Target slab size in bytes.

Values below 1024 are raised to 1024. Larger slabs reduce carry frequency for long records but increase the reusable buffer size.

§validate: bool

Validate FASTQ structure while framing records.

Validation checks the leading @, leading +, and sequence/quality length equality. Disable only for trusted inputs.

§pairing: PairingMode

Whether a single stream should be interpreted as unpaired or interleaved.

§pair_validation: PairValidation

Identifier validation policy for paired APIs.

Implementations§

Source§

impl FastqConfig

Source

pub fn interleaved(self) -> Self

Treat a single FASTQ stream as adjacent interleaved read pairs.

Source

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

Set the paired-read identifier validation policy.

Trait Implementations§

Source§

impl Clone for FastqConfig

Source§

fn clone(&self) -> FastqConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FastqConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for FastqConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.