Enum Nuc 

#[repr(u8)]
pub enum Nuc {
    A = 1,
    C = 2,
    G = 4,
    T = 8,
}

Concrete nucleotide

Nucs are ordered by the value of their ASCII representation.

Variants

A = 1

Adenine

C = 2

Cytosine

G = 4

Guanine

T = 8

Thymine

Implementations

impl Nuc

pub const ALL: [Self; 4]

All Nucs sorted in ascending order

pub const fn complement(self) -> Self

Swap A and T, as well as C and G.

Examples

use nucs::Nuc;

assert_eq!(Nuc::A.complement(), Nuc::T);
assert_eq!(Nuc::C.complement(), Nuc::G);
assert_eq!(Nuc::G.complement(), Nuc::C);
assert_eq!(Nuc::T.complement(), Nuc::A);

pub const fn to_str(self) -> &'static str

Return uppercase string representation

Examples

use nucs::Nuc;

assert_eq!(Nuc::A.to_str(), "A");

pub const fn from_ascii(ascii: u8) -> Result<Self, ParseSymbolError>

Construct from ASCII representation

Errors

Returns ParseSymbolError if the given byte isn’t A, C, G or T (case-insensitive).

Examples

use nucs::Nuc;

assert_eq!(Nuc::from_ascii(b'A'), Ok(Nuc::A));
assert!(Nuc::from_ascii(b'B').is_err());

pub const fn to_ascii(self) -> u8

Return uppercase ASCII representation

Examples

use nucs::Nuc;

assert_eq!(Nuc::A.to_ascii(), b'A');

pub const fn lit<const N: usize>(literal: &[u8; N]) -> [Nuc; N]

Construct Nuc array from literal without allocating.

Examples

use nucs::Nuc;

let dna1 = Nuc::lit(b"TACT");
// ...is shorthand for...
use Nuc::{T, A, C};
let dna2 = [T, A, C, T];

assert_eq!(dna1, dna2);

Panics

This panics if the supplied literal isn’t valid. Whitespace is NOT allowed because the returned array must have the same length.

Trait Implementations

impl AsMut<Nuc> for Nuc

fn as_mut(&mut self) -> &mut Nuc

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<Nuc> for Nuc

fn as_ref(&self) -> &Nuc

Converts this type into a shared reference of the (usually inferred) input type.

impl BitOr<&AmbiNuc> for &Nuc

type Output = AmbiNuc

The resulting type after applying the | operator.

fn bitor(self, rhs: &AmbiNuc) -> Self::Output

Performs the | operation.

impl BitOr<&Nuc> for &AmbiNuc

type Output = AmbiNuc

The resulting type after applying the | operator.

fn bitor(self, rhs: &Nuc) -> Self::Output

Performs the | operation.

impl BitOr<AmbiNuc> for Nuc

type Output = AmbiNuc

The resulting type after applying the | operator.

fn bitor(self, rhs: AmbiNuc) -> Self::Output

Performs the | operation.

impl BitOr<Nuc> for AmbiNuc

type Output = AmbiNuc

The resulting type after applying the | operator.

fn bitor(self, rhs: Nuc) -> Self::Output

Performs the | operation.

impl BitOr for &Nuc

type Output = AmbiNuc

The resulting type after applying the | operator.

fn bitor(self, rhs: &Nuc) -> Self::Output

Performs the | operation.

impl BitOr for Nuc

type Output = AmbiNuc

The resulting type after applying the | operator.

fn bitor(self, rhs: Nuc) -> Self::Output

Performs the | operation.

impl BitOrAssign<&Nuc> for AmbiNuc

fn bitor_assign(&mut self, rhs: &Nuc)

Performs the |= operation.

impl BitOrAssign<Nuc> for AmbiNuc

fn bitor_assign(&mut self, rhs: Nuc)

Performs the |= operation.

impl Clone for Nuc

fn clone(&self) -> Nuc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Nuc

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

Formats the value using the given formatter.

impl Display for Nuc

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

Formats the value using the given formatter.

impl From<Nuc> for AmbiNuc

fn from(nuc: Nuc) -> Self

Converts to this type from the input type.

impl FromStr for Nuc

type Err = ParseSymbolError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl Hash for Nuc

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

const ALL: &[Self]

All possible nucleotides in ascending order

type Amino = Amino

Amino acid; either Amino or AmbiAmino

fn complement(self) -> Self

Return this nucleotide’s complement.

fn translate<G: GeneticCode>(codon: [Self; 3], genetic_code: G) -> Self::Amino

Translate a codon into an amino acid

impl Ord for Nuc

fn cmp(&self, other: &Nuc) -> 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<AmbiNuc> for Nuc

fn eq(&self, other: &AmbiNuc) -> 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 PartialEq<Nuc> for AmbiNuc

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

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

fn partial_cmp(&self, other: &AmbiNuc) -> 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 PartialOrd<Nuc> for AmbiNuc

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

fn partial_cmp(&self, other: &Nuc) -> 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 Symbol for Nuc

type Concrete = Nuc

Concrete symbols, i.e. Nuc or Amino

type Ambiguous = AmbiNuc

Ambiguous symbols, i.e. AmbiNuc or AmbiAmino

fn to_str(self) -> &'static str

Return uppercase string representation

fn from_ascii(ascii: u8) -> Result<Self, ParseSymbolError>

Construct from (case-insensitive) ASCII representation

fn to_ascii(self) -> u8

Return uppercase ASCII representation

fn lit<const N: usize>(literal: &[u8; N]) -> [Self; N]

Construct array from literal without allocating.

impl TryFrom<AmbiNuc> for Nuc

type Error = AmbiNuc

The type returned in the event of a conversion error.

fn try_from(nuc: AmbiNuc) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Nuc

impl Eq for Nuc

impl StructuralPartialEq for Nuc