Struct consalign::Index

pub struct Index { /* private fields */ }

A FASTA index as created by SAMtools (.fai).

Implementations

impl Index

pub fn new<R>(fai: R) -> Result<Index, Error>where
    R: Read,

Open a FASTA index from a given io::Read instance.

pub fn from_file<P>(path: &P) -> Result<Index, Error>where
    P: AsRef<Path>,

Open a FASTA index from a given file path.

pub fn with_fasta_file<P>(fasta_path: &P) -> Result<Index, Error>where
    P: AsRef<Path>,

Open a FASTA index given the corresponding FASTA file path. That is, for ref.fasta we expect ref.fasta.fai.

pub fn sequences(&self) -> Vec<Sequence, Global>

Return a vector of sequences described in the index.

Trait Implementations

impl Clone for Index

fn clone(&self) -> Index

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Index

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

Formats the value using the given formatter.