Struct FastaIndex 

pub struct FastaIndex { /* private fields */ }

A .fai-style FASTA index.

Implementations

impl FastaIndex

pub fn entries(&self) -> &[FastaIndexEntry]

Return all index entries in FASTA order.

pub fn is_empty(&self) -> bool

Return whether the index contains no references.

pub fn len(&self) -> usize

Return the number of references in the index.

pub fn get(&self, name: &[u8]) -> Option<&FastaIndexEntry>

Find an entry by reference name bytes.

pub fn to_fai_string(&self) -> String

Render the standard five-column .fai representation.

pub fn from_fai_bytes(bytes: &[u8]) -> Result<Self>

Parse a standard five-column .fai index from bytes.

pub fn from_fai_str(text: &str) -> Result<Self>

Parse a standard five-column .fai index from UTF-8 text.

pub fn from_fai_read<R: Read>(reader: R) -> Result<Self>

Parse a standard five-column .fai index from a reader.

Trait Implementations

impl Clone for FastaIndex

fn clone(&self) -> FastaIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FastaIndex

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

Formats the value using the given formatter.

impl Default for FastaIndex

fn default() -> FastaIndex

Returns the “default value” for a type.

impl Eq for FastaIndex

impl PartialEq for FastaIndex

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for FastaIndex