Enum Alphabet 

#[non_exhaustive]
pub enum Alphabet {
    Dna,
    Rna,
    Iupac,
    Protein,
    Any,
}

A residue alphabet used for validation.

Marked #[non_exhaustive]: alphabets are a judgement call, not a closed set, so adding one should not break callers. Alphabets are normally passed in rather than matched on, which makes the cost of the annotation close to zero.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Dna

ACGT plus N, either case.

Rna

ACGU plus N, either case.

Iupac

The full IUPAC nucleotide set plus - and . gaps.

Protein

The 20 amino acids plus BXZJUO*-., either case.

Any

Any printable, non-whitespace byte.

Implementations

impl Alphabet

pub fn contains(self, byte: u8) -> bool

Whether byte is a member of the alphabet.

pub fn validate(self, seq: &[u8]) -> Result<()>

Check every byte of seq, reporting the first violation.

pub fn validate_named(self, seq: &[u8], id: &str) -> Result<()>

Like Alphabet::validate but attaches a record id to the error.

Trait Implementations

impl Clone for Alphabet

fn clone(&self) -> Alphabet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Alphabet

impl Debug for Alphabet

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

Formats the value using the given formatter.

impl Eq for Alphabet

impl Hash for Alphabet

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Alphabet

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Alphabet