Skip to main content

Reference

Struct Reference 

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

Reference sequence storage

Loads and stores reference sequences from .3.rai and .4.rai RustAlign index files. The reference is stored in bit-packed format (2 bits per nucleotide).

Implementations§

Source§

impl Reference

Source

pub fn load<P: AsRef<Path>>(path_base: P) -> AlignResult<Self>

Load reference from .3.rai and .4.rai files

§Arguments
  • path_base - Path to the index base (without extensions)
Source

pub fn n_refs(&self) -> u32

Get the number of reference sequences

Source

pub fn approx_len(&self, tidx: u32) -> u64

Get the approximate length of a reference sequence

Source

pub fn get_stretch( &self, buf: &[u8], tidx: u32, toff: u64, count: usize, ) -> AlignResult<Vec<Nuc>>

Extract a stretch of reference sequence

§Arguments
  • buf - The bit-packed reference buffer from .4.rai file
  • tidx - Reference sequence index (chromosome index)
  • toff - Offset within the reference sequence
  • count - Number of bases to extract
§Returns

A vector of nucleotides

Source

pub fn buf_sz(&self) -> u64

Get the buffer size needed

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.