rsxiv 0.4.3

Tools for working with arXiv and the arXiv API
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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228

/// The possible archives present in an old-style arxiv identifier.
///
/// ## String representation
/// The string representation of an [`Archive`] variant is the variant name in kebab-case.
/// ```
/// use rsxiv::id::Archive;
/// assert_eq!(Archive::ChaoDyn.to_id(), "chao-dyn");
/// assert_eq!(Archive::from_id("funct-an"), Some(Archive::FunctAn));
/// ```
///
// SAFETY: Do not change the layout of this enum.
// 1. The 0 discriminant is free to help the compiler optimize around Option<Archive>.
// 2. The discriminants must be continguous, starting at 1 and in increasing order (to ensure
//    correct ordering).
// 3. The maximum discriminant must be `Archive::SuprCon`.
#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Clone, Copy)]
#[repr(u8)]
pub enum Archive {
    /// Accelerator Physics
    AccPhys = 1,
    /// Adaptation and Self-Organizing Systems
    AdapOrg = 2,
    /// Algebraic Geometry
    AlgGeom = 3,
    /// Atmospheric and Oceanic Physics
    AoSci = 4,
    /// Astrophysics
    AstroPh = 5,
    /// Atomic Physics
    AtomPh = 6,
    /// Bayesian Analysis
    BayesAn = 7,
    /// Chaotic Dynamics
    ChaoDyn = 8,
    /// Chemical Physics
    ChemPh = 9,
    /// Computation and Language
    CmpLg = 10,
    /// Cellular Automata and Lattice Gases
    CompGas = 11,
    /// Condensed Matter
    CondMat = 12,
    /// Computer Science
    Cs = 13,
    /// Differential Geometry
    DgGa = 14,
    /// Functional Analysis
    FunctAn = 15,
    /// General Relativity and Quantum Cosmology
    GrQc = 16,
    /// High Energy Physics - Experiment
    HepEx = 17,
    /// High Energy Physics - Lattice
    HepLat = 18,
    /// High Energy Physics - Phenomenology
    HepPh = 19,
    /// High Energy Physics - Theory
    HepTh = 20,
    /// Mathematics,
    Math = 21,
    /// Mathematical Physics
    MathPh = 22,
    /// Materials Science
    MtrlTh = 23,
    /// Nonlinear Sciences
    Nlin = 24,
    /// Nuclear Experiment
    NuclEx = 25,
    /// Nuclear Theory
    NuclTh = 26,
    /// Pattern Formation and Solitons
    PattSol = 27,
    /// Physics
    Physics = 28,
    /// Plasma Physics
    PlasmPh = 29,
    /// Quantum Algebra
    QAlg = 30,
    /// Quantitative Biology
    QBio = 31,
    /// Quantum Physics
    QuantPh = 32,
    /// Exactly Solvable and Integrable Systems
    SolvInt = 33,
    /// Superconductivity
    SuprCon = 34,
}

impl Archive {
    /// Convert to a raw identifier, as used internally by arXiv.
    ///
    /// The raw identifier is the enum variant name in kebab-case.
    /// ```
    /// use rsxiv::id::Archive;
    /// assert_eq!(Archive::QuantPh.to_id(), "quant-ph");
    /// ```
    #[inline]
    #[must_use]
    pub const fn to_id(&self) -> &'static str {
        match self {
            Archive::AccPhys => "acc-phys",
            Archive::AdapOrg => "adap-org",
            Archive::AlgGeom => "alg-geom",
            Archive::AoSci => "ao-sci",
            Archive::AstroPh => "astro-ph",
            Archive::AtomPh => "atom-ph",
            Archive::BayesAn => "bayes-an",
            Archive::ChaoDyn => "chao-dyn",
            Archive::ChemPh => "chem-ph",
            Archive::CmpLg => "cmp-lg",
            Archive::CompGas => "comp-gas",
            Archive::CondMat => "cond-mat",
            Archive::Cs => "cs",
            Archive::DgGa => "dg-ga",
            Archive::FunctAn => "funct-an",
            Archive::GrQc => "gr-qc",
            Archive::HepEx => "hep-ex",
            Archive::HepLat => "hep-lat",
            Archive::HepPh => "hep-ph",
            Archive::HepTh => "hep-th",
            Archive::Math => "math",
            Archive::MathPh => "math-ph",
            Archive::MtrlTh => "mtrl-th",
            Archive::Nlin => "nlin",
            Archive::NuclEx => "nucl-ex",
            Archive::NuclTh => "nucl-th",
            Archive::PattSol => "patt-sol",
            Archive::Physics => "physics",
            Archive::PlasmPh => "plasm-ph",
            Archive::QAlg => "q-alg",
            Archive::QBio => "q-bio",
            Archive::QuantPh => "quant-ph",
            Archive::SolvInt => "solv-int",
            Archive::SuprCon => "supr-con",
        }
    }

    /// Read from a raw identifier.
    ///
    /// The raw identifier is the enum variant name in kebab-case.
    /// ```
    /// use rsxiv::id::Archive;
    /// assert_eq!(Archive::from_id("math"), Some(Archive::Math));
    /// ```
    /// The identifier must match exactly, or this will fail.
    /// ```
    /// # use rsxiv::id::Archive;
    /// assert_eq!(Archive::from_id("solv-int "), None);
    /// ```
    #[must_use]
    pub const fn from_id(id: &str) -> Option<Self> {
        Self::from_id_bytes(id.as_bytes())
    }

    /// Read from a raw identifier as bytes.
    ///
    /// The raw identifier is the enum variant name in kebab-case.
    /// ```
    /// use rsxiv::id::Archive;
    /// assert_eq!(Archive::from_id_bytes(b"supr-con"), Some(Archive::SuprCon));
    /// ```
    #[must_use]
    pub const fn from_id_bytes(id: &[u8]) -> Option<Self> {
        match strip_archive_prefix_bytes(id) {
            Some((archive, b"")) => Some(archive),
            _ => None,
        }
    }
}

/// Strip an archive prefix, returning the archive and trailing characters if matched.
///
/// ```
/// use rsxiv::id::{Archive, strip_archive_prefix};
///
/// assert_eq!(strip_archive_prefix("alg-geomabc"), Some((Archive::AlgGeom, "abc")));
/// ```
#[inline]
pub const fn strip_archive_prefix(s: &str) -> Option<(Archive, &str)> {
    match strip_archive_prefix_bytes(s.as_bytes()) {
        Some((archive, tail)) => unsafe { Some((archive, std::str::from_utf8_unchecked(tail))) },
        None => None,
    }
}

/// Strip an archive prefix, returning the archive and trailing characters if matched.
///
/// This is implemented as a const match table which gets optimized quite well by the compiler.
#[inline]
pub const fn strip_archive_prefix_bytes(s: &[u8]) -> Option<(Archive, &[u8])> {
    match s {
        [b'a', b'c', b'c', b'-', b'p', b'h', b'y', b's', t @ ..] => Some((Archive::AccPhys, t)),
        [b'a', b'd', b'a', b'p', b'-', b'o', b'r', b'g', t @ ..] => Some((Archive::AdapOrg, t)),
        [b'a', b'l', b'g', b'-', b'g', b'e', b'o', b'm', t @ ..] => Some((Archive::AlgGeom, t)),
        [b'a', b'o', b'-', b's', b'c', b'i', t @ ..] => Some((Archive::AoSci, t)),
        [b'a', b's', b't', b'r', b'o', b'-', b'p', b'h', t @ ..] => Some((Archive::AstroPh, t)),
        [b'a', b't', b'o', b'm', b'-', b'p', b'h', t @ ..] => Some((Archive::AtomPh, t)),
        [b'b', b'a', b'y', b'e', b's', b'-', b'a', b'n', t @ ..] => Some((Archive::BayesAn, t)),
        [b'c', b'h', b'a', b'o', b'-', b'd', b'y', b'n', t @ ..] => Some((Archive::ChaoDyn, t)),
        [b'c', b'h', b'e', b'm', b'-', b'p', b'h', t @ ..] => Some((Archive::ChemPh, t)),
        [b'c', b'm', b'p', b'-', b'l', b'g', t @ ..] => Some((Archive::CmpLg, t)),
        [b'c', b'o', b'm', b'p', b'-', b'g', b'a', b's', t @ ..] => Some((Archive::CompGas, t)),
        [b'c', b'o', b'n', b'd', b'-', b'm', b'a', b't', t @ ..] => Some((Archive::CondMat, t)),
        [b'c', b's', t @ ..] => Some((Archive::Cs, t)),
        [b'd', b'g', b'-', b'g', b'a', t @ ..] => Some((Archive::DgGa, t)),
        [b'f', b'u', b'n', b'c', b't', b'-', b'a', b'n', t @ ..] => Some((Archive::FunctAn, t)),
        [b'g', b'r', b'-', b'q', b'c', t @ ..] => Some((Archive::GrQc, t)),
        [b'h', b'e', b'p', b'-', b'e', b'x', t @ ..] => Some((Archive::HepEx, t)),
        [b'h', b'e', b'p', b'-', b'l', b'a', b't', t @ ..] => Some((Archive::HepLat, t)),
        [b'h', b'e', b'p', b'-', b'p', b'h', t @ ..] => Some((Archive::HepPh, t)),
        [b'h', b'e', b'p', b'-', b't', b'h', t @ ..] => Some((Archive::HepTh, t)),
        [b'm', b'a', b't', b'h', b'-', b'p', b'h', t @ ..] => Some((Archive::MathPh, t)),
        [b'm', b'a', b't', b'h', t @ ..] => Some((Archive::Math, t)),
        [b'm', b't', b'r', b'l', b'-', b't', b'h', t @ ..] => Some((Archive::MtrlTh, t)),
        [b'n', b'l', b'i', b'n', t @ ..] => Some((Archive::Nlin, t)),
        [b'n', b'u', b'c', b'l', b'-', b'e', b'x', t @ ..] => Some((Archive::NuclEx, t)),
        [b'n', b'u', b'c', b'l', b'-', b't', b'h', t @ ..] => Some((Archive::NuclTh, t)),
        [b'p', b'a', b't', b't', b'-', b's', b'o', b'l', t @ ..] => Some((Archive::PattSol, t)),
        [b'p', b'h', b'y', b's', b'i', b'c', b's', t @ ..] => Some((Archive::Physics, t)),
        [b'p', b'l', b'a', b's', b'm', b'-', b'p', b'h', t @ ..] => Some((Archive::PlasmPh, t)),
        [b'q', b'-', b'a', b'l', b'g', t @ ..] => Some((Archive::QAlg, t)),
        [b'q', b'-', b'b', b'i', b'o', t @ ..] => Some((Archive::QBio, t)),
        [b'q', b'u', b'a', b'n', b't', b'-', b'p', b'h', t @ ..] => Some((Archive::QuantPh, t)),
        [b's', b'o', b'l', b'v', b'-', b'i', b'n', b't', t @ ..] => Some((Archive::SolvInt, t)),
        [b's', b'u', b'p', b'r', b'-', b'c', b'o', b'n', t @ ..] => Some((Archive::SuprCon, t)),
        _ => None,
    }
}