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> + Debug,

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.

impl Default for Index

fn default() -> Index

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Index

fn deserialize<__D>( __deserializer: __D ) -> Result<Index, <__D as Deserializer<'de>>::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<Index> for Index

fn eq(&self, other: &Index) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Index

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Index

impl StructuralEq for Index

impl StructuralPartialEq for Index