Skip to main content

Aligner

Trait Aligner 

Source
pub trait Aligner: Send + Sync {
    // Required methods
    fn name(&self) -> &'static str;
    fn align(
        &self,
        query_fasta: &Path,
        target_fasta: &Path,
        opts: &AlignOpts,
    ) -> Result<Vec<Hit>, AlignError>;
}
Expand description

Common trait implemented by every aligner backend.

Required Methods§

Source

fn name(&self) -> &'static str

Short label printed in logs ("blast", "diamond", "mmseqs2", "tblastn", "precomputed").

Source

fn align( &self, query_fasta: &Path, target_fasta: &Path, opts: &AlignOpts, ) -> Result<Vec<Hit>, AlignError>

Align query_fasta against target_fasta. The target_fasta may be a protein or nucleotide file depending on the backend — check the impl’s docs.

Implementors§