Struct bio::io::fasta::Index

pub struct Index {
    // some fields omitted
}

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

Methods

impl Index

fn new<R: Read>(fai: R) -> Result<Self>

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

fn from_file<P: AsRef<Path>>(path: &P) -> Result<Self>

Open a FASTA index from a given file path.

fn with_fasta_file<P: AsRef<Path>>(fasta_path: &P) -> Result<Self>

Open a FASTA index given the corresponding FASTA file path (e.g. for ref.fasta we expect ref.fasta.fai).

fn sequences(&self) -> Vec<Sequence>

Return a vector of sequences described in the index.