Struct seq_io::fastx::dynamic::ReaderBuilder

pub struct ReaderBuilder<P: BufPolicy = StdPolicy, S: PositionStore = LineStore> { /* fields omitted */ }

Allows building a FastxReader or FastxSeekReader with various configuration options.

Implementations

impl ReaderBuilder

pub fn new() -> Self

Creates a new ReaderBuilder

impl<P, S> ReaderBuilder<P, S> where
    P: BufPolicy,
    S: PositionStore, 

pub fn from_reader<'s, R>(
    self,
    reader: R
) -> Result<Option<Box<dyn FastxReader<R, P, S> + 's>>> where
    R: Read + 's,
    P: 's,
    S: 's, 

Creates a new FastxReader with the current configuration of the builder. See reader for more information about the behaviour.

pub fn from_path<'s, Q>(
    self,
    path: Q
) -> Result<Option<Box<dyn FastxSeekReader<File, P, S> + 's>>> where
    Q: AsRef<Path> + 's,
    P: 's,
    S: 's, 

Creates a new FastxSeekReader from the given path with the current configuration of the builder.

pub fn from_seekable<'s, R>(
    self,
    reader: R
) -> Result<Option<Box<dyn FastxSeekReader<R, P, S> + 's>>> where
    R: Read + Seek + 's,
    P: 's,
    S: 's, 

Creates a new FastxSeekReader with the current configuration of the builder.

pub fn set_store<T: PositionStore>(self) -> ReaderBuilder<P, T>

Creates a new reader with a given core::PositionStore as defined in the type argument of the method. The method consumes the reader and returns a new Reader instance.

pub fn set_policy<T: BufPolicy>(self, buf_policy: T) -> ReaderBuilder<T, S>

Applies a BufPolicy to the current reader. The method consumes the reader and returns a new Reader instance.

pub fn set_capacity(self, cap: usize) -> Self

Sets a reader capacity.

pub fn set_multiline_fastq(self, multiline: bool) -> Self

Sets whether multi-line FASTQ should be recognized by the reader. If true, the final reader will be fastq::multiline::Reader in the case of FASTQ input.

Trait Implementations

impl<P: Debug + BufPolicy, S: Debug + PositionStore> Debug for ReaderBuilder<P, S>

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

Formats the value using the given formatter.