Enum Nucleotide 

pub enum Nucleotide {
    Adenine,
    Cytosine,
    Guanine,
    Thymine,
    Uracil,
    Gap,
    Ambiguous(char),
    Unknown,
}

A primitive nucleotide symbol.

Variants

Adenine

Adenine, displayed as A.

Cytosine

Cytosine, displayed as C.

Guanine

Guanine, displayed as G.

Thymine

Thymine, displayed as T.

Uracil

Uracil, displayed as U.

Gap

Gap, displayed as -.

Ambiguous(char)

Ambiguous nucleotide symbol, such as N.

Unknown

Explicit unknown nucleotide, displayed as ?.

Implementations

impl Nucleotide

pub const fn parse_symbol( symbol: char, ) -> Result<Nucleotide, NucleotideParseError>

Parses a common nucleotide symbol.

Recognized symbols are A, C, G, T, U, -, and N in either case for letters. Other symbols return NucleotideParseError::InvalidSymbol.

Errors

Returns NucleotideParseError::InvalidSymbol when the symbol is not recognized.

pub const fn symbol(self) -> char

Returns the canonical display symbol.

pub const fn kind(self) -> NucleotideKind

Returns the descriptive nucleotide kind.

Trait Implementations

impl Clone for Nucleotide

fn clone(&self) -> Nucleotide

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Nucleotide

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

Formats the value using the given formatter.

impl Display for Nucleotide

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

Formats the value using the given formatter.

impl FromStr for Nucleotide

type Err = NucleotideParseError

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Nucleotide, <Nucleotide as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for Nucleotide

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

where __H: Hasher,

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 Ord for Nucleotide

fn cmp(&self, other: &Nucleotide) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Nucleotide

fn eq(&self, other: &Nucleotide) -> 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 PartialOrd for Nucleotide

fn partial_cmp(&self, other: &Nucleotide) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Nucleotide

impl Eq for Nucleotide

impl StructuralPartialEq for Nucleotide