Struct SequenceDictionary 

pub struct SequenceDictionary { /* private fields */ }

A lookup table mapping reference sequence names to their indices and lengths.

Constructed from a FASTA index, this type consolidates all name-index-length mapping into a single shared structure.

Implementations

impl SequenceDictionary

pub fn len(&self) -> usize

Return the number of sequences.

pub fn is_empty(&self) -> bool

Return true if the dictionary contains no sequences.

pub fn get_by_index(&self, index: usize) -> Option<&SequenceMetadata>

Look up a sequence by its 0-based index.

pub fn get_by_name(&self, name: &str) -> Option<&SequenceMetadata>

Look up a sequence by name.

pub fn iter(&self) -> impl Iterator<Item = &SequenceMetadata>

Iterate over all sequences in index order.

pub fn names(&self) -> Vec<&str>

Return contig names in index order.

pub fn total_length(&self) -> u64

Return the total length of all sequences combined.

pub fn from_entries(sequences: Vec<SequenceMetadata>) -> Self

Build a dictionary from a pre-constructed list of entries.

Useful for testing and for cases where the dictionary is constructed from sources other than a FASTA index. Entries are re-indexed by their position in the vector (the index field of each SequenceMetadata is ignored and replaced).

Trait Implementations

impl Clone for SequenceDictionary

fn clone(&self) -> SequenceDictionary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SequenceDictionary

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

Formats the value using the given formatter.

impl From<&Index> for SequenceDictionary

fn from(index: &Index) -> Self

Converts to this type from the input type.

impl Index<&str> for SequenceDictionary

type Output = SequenceMetadata

The returned type after indexing.

fn index(&self, name: &str) -> &SequenceMetadata

Performs the indexing (container[index]) operation.

impl Index<usize> for SequenceDictionary

type Output = SequenceMetadata

The returned type after indexing.

fn index(&self, index: usize) -> &SequenceMetadata

Performs the indexing (container[index]) operation.