Struct seqkmer::fasta::BufferFastaReader

source ·
pub struct BufferFastaReader<R>
where R: Read + Send,
{ /* private fields */ }
Expand description

BufferFastaReader for reading FASTA format files with buffering.

§Examples

use seqkmer::{BufferFastaReader, Reader};
use std::path::Path;

let path = Path::new("tests/data/test.fasta");
let mut reader = BufferFastaReader::from_path(path, 0)?;

while let Some(sequences) = reader.next()? {
    for sequence in sequences {
        println!("Sequence ID: {}", sequence.header.id);
        println!("Sequence length: {}", sequence.body.single().unwrap().len());
    }
}

Implementations§

source§

impl<R> BufferFastaReader<R>
where R: Read + Send,

source

pub fn new(reader: R, file_index: usize) -> Self

Creates a new BufferFastaReader with default capacity and batch size.

§Examples
use seqkmer::BufferFastaReader;
use std::fs::File;

let file = File::open("tests/data/test.fasta")?;
let reader = BufferFastaReader::new(file, 0);
source

pub fn with_capacity( reader: R, file_index: usize, capacity: usize, batch_size: usize, ) -> Self

Creates a new BufferFastaReader with specified capacity and batch size.

§Examples
use seqkmer::BufferFastaReader;
use std::fs::File;

let file = File::open("tests/data/test.fasta")?;
let reader = BufferFastaReader::with_capacity(file, 0, 4096, 50);
source

pub fn read_next(&mut self) -> Result<Option<()>>

source

pub fn _next(&mut self) -> Result<Option<Base<Vec<u8>>>>

source§

impl BufferFastaReader<Box<dyn Read + Send>>

source

pub fn from_path<P: AsRef<Path>>(path: P, file_index: usize) -> Result<Self>

Creates a new BufferFastaReader from a file path.

§Examples
use seqkmer::BufferFastaReader;
use std::path::Path;

let path = Path::new("tests/data/test.fasta");
let reader = BufferFastaReader::from_path(path, 0)?;

Trait Implementations§

Auto Trait Implementations§

§

impl<R> Freeze for BufferFastaReader<R>
where R: Freeze,

§

impl<R> RefUnwindSafe for BufferFastaReader<R>
where R: RefUnwindSafe,

§

impl<R> Send for BufferFastaReader<R>

§

impl<R> Sync for BufferFastaReader<R>
where R: Sync,

§

impl<R> Unpin for BufferFastaReader<R>
where R: Unpin,

§

impl<R> UnwindSafe for BufferFastaReader<R>
where R: 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.