nucs 0.3.0

Library for working with nucleotide and amino acid sequences
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

//! Error types

use std::error::Error;
use std::fmt::{Debug, Display, Formatter};

use crate::Symbol;

/// Error parsing [`Nuc`](crate::Nuc), [`AmbiNuc`](crate::AmbiNuc),
/// [`Amino`](crate::Amino) or [`AmbiAmino`](crate::AmbiAmino)
#[derive(Clone, PartialEq, Eq)]
pub struct ParseSymbolError {
    pub(crate) kind: &'static str,
    pub(crate) expected: &'static str,
}

impl ParseSymbolError {
    pub(crate) const fn new<S: Symbol>() -> Self {
        ParseSymbolError {
            kind: S::NAME,
            expected: S::EXPECTED,
        }
    }
}

impl Display for ParseSymbolError {
    fn fmt(&self, f: &mut Formatter) -> std::fmt::Result {
        let Self { kind, expected } = self;
        write!(f, "invalid {kind}: expected {expected}")
    }
}

impl Debug for ParseSymbolError {
    fn fmt(&self, f: &mut Formatter) -> std::fmt::Result {
        f.debug_struct("ParseSymbolError").finish_non_exhaustive()
    }
}

impl Error for ParseSymbolError {}

/// Error parsing sequence of [`Nuc`](crate::Nuc), [`AmbiNuc`](crate::AmbiNuc),
/// [`Amino`](crate::Amino) or [`AmbiAmino`](crate::AmbiAmino)
#[derive(Clone, PartialEq, Eq)]
pub struct ParseSeqError {
    pub(crate) kind: &'static str,
    pub(crate) expected: &'static str,
    pub(crate) chr: char,
    pub(crate) pos: usize,
}

impl ParseSeqError {
    /// The position (measured in codepoints, not bytes) where parsing failed.
    #[must_use]
    pub fn position(&self) -> usize {
        self.pos
    }

    /// The unexpected character that cause parsing to fail.
    #[must_use]
    pub fn char(&self) -> char {
        self.chr
    }
}

impl Display for ParseSeqError {
    fn fmt(&self, f: &mut Formatter) -> std::fmt::Result {
        let Self {
            kind,
            expected,
            chr,
            pos,
        } = self;
        write!(
            f,
            "invalid {kind} {chr:?} at position {pos}: expected {expected}"
        )
    }
}

impl Debug for ParseSeqError {
    fn fmt(&self, f: &mut Formatter) -> std::fmt::Result {
        f.debug_struct("ParseSeqError")
            .field("chr", &self.chr)
            .field("pos", &self.pos)
            .finish_non_exhaustive()
    }
}

impl Error for ParseSeqError {}