Skip to main content

ReadBatch

Struct ReadBatch 

Source
pub struct ReadBatch { /* private fields */ }
Expand description

A batch of paired-end reads to map.

All slices must have the same length (count). Sequences are ASCII DNA strings (ACGTN) and qualities are phred+33 ASCII strings.

Implementations§

Source§

impl ReadBatch

Source

pub fn new() -> Self

Create a new empty batch.

Source

pub fn with_capacity(n: usize) -> Self

Create a batch with pre-allocated capacity for n pairs.

Source

pub fn push( &mut self, name: &str, r1: ReadEnd<'_>, r2: ReadEnd<'_>, ) -> Result<(), YaraError>

Add a read pair to the batch.

§Errors

Returns YaraError::InvalidInput if any input contains a null byte or if sequence and quality lengths do not match.

Source

pub fn len(&self) -> usize

Number of read pairs in the batch.

Source

pub fn is_empty(&self) -> bool

Whether the batch is empty.

Source

pub fn clear(&mut self)

Clear all reads, retaining allocated capacity for reuse.

Trait Implementations§

Source§

impl Default for ReadBatch

Source§

fn default() -> ReadBatch

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> 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.