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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
use std::fmt::{self, Display};
use std::io::{self, Write};

use bstr::{BStr, BString};
#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};
use winnow::Parser;

use super::parse::parse_occurrence_ref;
use super::ParsePicaError;

/// An immutable occurrence.
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct OccurrenceRef<'a>(
    #[cfg_attr(feature = "serde", serde(borrow))] &'a BStr,
);

impl<'a> OccurrenceRef<'a> {
    /// Create a new [OccurrenceRef] from a string slice.
    ///
    /// # Panics
    ///
    /// This method panics if the occurrence is invalid.
    ///
    /// # Example
    ///
    /// ```rust
    /// use pica_record::primitives::OccurrenceRef;
    ///
    /// let occurrence = OccurrenceRef::new("001")?;
    /// assert_eq!(occurrence, "001");
    ///
    /// # Ok::<(), Box<dyn std::error::Error>>(())
    /// ```
    #[inline]
    pub fn new(occ: &'a str) -> Result<Self, ParsePicaError> {
        Self::from_bytes(occ.as_bytes())
    }

    /// Create a new [OccurrenceRef] without checking for validity.
    ///
    /// # Safety
    ///
    /// The caller must ensure that the occurrence is valid.
    ///
    /// # Example
    ///
    /// ```rust
    /// use pica_record::primitives::OccurrenceRef;
    ///
    /// let occurrence = OccurrenceRef::from_unchecked("001");
    /// assert_eq!(occurrence, "001");
    ///
    /// # Ok::<(), Box<dyn std::error::Error>>(())
    /// ```
    #[inline]
    pub fn from_unchecked<T: AsRef<[u8]> + ?Sized>(
        occurrence: &'a T,
    ) -> Self {
        Self(occurrence.as_ref().into())
    }

    /// Create a new [OccurrenceRef] from a byte slice.
    ///
    /// # Panics
    ///
    /// This method panics if the occurrence is invalid.
    ///
    /// # Example
    ///
    /// ```rust
    /// use pica_record::primitives::OccurrenceRef;
    ///
    /// let occurrence = OccurrenceRef::from_bytes(b"00")?;
    /// assert_eq!(occurrence, "00");
    ///
    /// # Ok::<(), Box<dyn std::error::Error>>(())
    /// ```
    #[inline]
    pub fn from_bytes<B: AsRef<[u8]> + ?Sized>(
        occurrence: &'a B,
    ) -> Result<Self, ParsePicaError> {
        let bytes = occurrence.as_ref();

        parse_occurrence_ref.parse(bytes).map_err(|_| {
            ParsePicaError(format!("invalid occurrence '{bytes:?}'"))
        })
    }

    /// Returns the [OccurrenceRef] as a byte slice.
    ///
    /// # Example
    ///
    /// ```rust
    /// use pica_record::primitives::OccurrenceRef;
    ///
    /// let occurrence = OccurrenceRef::from_bytes(b"01")?;
    /// assert_eq!(occurrence.as_bytes(), b"01");
    ///
    /// # Ok::<(), Box<dyn std::error::Error>>(())
    /// ```
    #[inline]
    pub fn as_bytes(&self) -> &[u8] {
        self.0
    }

    /// Write the [OccurrenceRef] into the given writer.
    ///
    /// # Example
    ///
    /// ```rust
    /// use std::io::Cursor;
    ///
    /// use pica_record::primitives::OccurrenceRef;
    ///
    /// let mut writer = Cursor::new(Vec::<u8>::new());
    /// let occurrence = OccurrenceRef::new("01")?;
    /// occurrence.write_to(&mut writer);
    ///
    /// assert_eq!(String::from_utf8(writer.into_inner())?, "/01");
    ///
    /// # Ok::<(), Box<dyn std::error::Error>>(())
    /// ```
    #[inline]
    pub fn write_to(&self, out: &mut impl Write) -> io::Result<()> {
        write!(out, "/{}", self.0)
    }
}

impl<T: AsRef<[u8]>> PartialEq<T> for OccurrenceRef<'_> {
    /// Compare a [OccurrenceRef] with a string slice.
    ///
    /// # Example
    ///
    /// ```rust
    /// use pica_record::primitives::OccurrenceRef;
    ///
    /// let occurrence = OccurrenceRef::from_bytes(b"01")?;
    /// assert_eq!(occurrence, b"01");
    ///
    /// # Ok::<(), Box<dyn std::error::Error>>(())
    /// ```
    fn eq(&self, occurrence: &T) -> bool {
        self.0 == occurrence.as_ref()
    }
}

/// A mutable occurrence.
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[allow(clippy::len_without_is_empty)]
pub struct Occurrence(BString);

impl Occurrence {
    /// Create a new [OccurrenceRef] from a string slice.
    ///
    /// # Panics
    ///
    /// This method panics if the occurrence is invalid.
    ///
    /// # Example
    ///
    /// ```rust
    /// use pica_record::primitives::OccurrenceRef;
    ///
    /// let occurrence = OccurrenceRef::new("001")?;
    /// assert_eq!(occurrence, "001");
    ///
    /// # Ok::<(), Box<dyn std::error::Error>>(())
    /// ```
    #[inline]
    pub fn new(occurrence: &str) -> Result<Self, ParsePicaError> {
        Ok(Self::from(OccurrenceRef::from_bytes(
            occurrence.as_bytes(),
        )?))
    }

    /// Returns the [Occurrence] as a byte slice.
    ///
    /// # Example
    ///
    /// ```rust
    /// use pica_record::primitives::Occurrence;
    ///
    /// let occurrence = Occurrence::new("001")?;
    /// assert_eq!(occurrence.as_bytes(), b"001");
    ///
    /// # Ok::<(), Box<dyn std::error::Error>>(())
    /// ```
    #[inline]
    pub fn as_bytes(&self) -> &[u8] {
        self.0.as_ref()
    }

    /// Returns the length (number of digits) of the [Occurrence].
    ///
    /// # Example
    ///
    /// ```rust
    /// use pica_record::primitives::Occurrence;
    ///
    /// let occurrence = Occurrence::new("001")?;
    /// assert_eq!(occurrence.len(), 3);
    ///
    /// # Ok::<(), Box<dyn std::error::Error>>(())
    /// ```
    #[inline]
    pub fn len(&self) -> usize {
        self.0.len()
    }

    /// Write the [Occurrence] into the given writer.
    ///
    /// # Example
    ///
    /// ```rust
    /// use std::io::Cursor;
    ///
    /// use pica_record::primitives::Occurrence;
    ///
    /// let mut writer = Cursor::new(Vec::<u8>::new());
    /// let occurrence = Occurrence::new("01")?;
    /// occurrence.write_to(&mut writer);
    ///
    /// assert_eq!(String::from_utf8(writer.into_inner())?, "/01");
    /// # Ok::<(), Box<dyn std::error::Error>>(())
    /// ```
    #[inline]
    pub fn write_to(&self, out: &mut impl Write) -> io::Result<()> {
        write!(out, "/{}", self.0)
    }
}

impl Display for Occurrence {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.0)
    }
}

impl From<OccurrenceRef<'_>> for Occurrence {
    /// Creates a [Occurrence] from a [OccurrenceRef].
    ///
    /// # Example
    ///
    /// ```rust
    /// use pica_record::primitives::{Occurrence, OccurrenceRef};
    ///
    /// let occ_ref = OccurrenceRef::new("001")?;
    /// let occ = Occurrence::from(occ_ref);
    /// assert_eq!(occ, "001");
    ///
    /// # Ok::<(), Box<dyn std::error::Error>>(())
    /// ```
    fn from(occurrence: OccurrenceRef<'_>) -> Self {
        let OccurrenceRef(occ) = occurrence;
        Self(occ.into())
    }
}

impl PartialEq<&str> for Occurrence {
    /// Compares a [Occurrence] with a string slice.
    ///
    /// # Example
    ///
    /// ```rust
    /// use pica_record::primitives::Occurrence;
    ///
    /// let occ = Occurrence::new("999")?;
    /// assert_eq!(occ, "999");
    ///
    /// # Ok::<(), Box<dyn std::error::Error>>(())
    /// ```
    fn eq(&self, other: &&str) -> bool {
        self.0 == other.as_bytes()
    }
}

impl PartialEq<Occurrence> for OccurrenceRef<'_> {
    /// Compares a [OccurrenceRef] with [Occurrence].
    ///
    /// # Example
    ///
    /// ```rust
    /// use pica_record::primitives::{Occurrence, OccurrenceRef};
    ///
    /// let occ_ref = OccurrenceRef::new("999")?;
    /// let occ = Occurrence::new("999")?;
    /// assert_eq!(occ_ref, occ);
    ///
    /// # Ok::<(), Box<dyn std::error::Error>>(())
    /// ```
    #[inline]
    fn eq(&self, other: &Occurrence) -> bool {
        self.0 == other.0
    }
}

#[cfg(test)]
impl quickcheck::Arbitrary for Occurrence {
    fn arbitrary(g: &mut quickcheck::Gen) -> Self {
        let size = *g.choose(&[2, 3]).unwrap();
        let value = (0..size)
            .map(|_| *g.choose(b"0123456789").unwrap())
            .collect::<Vec<u8>>();

        Occurrence(value.into())
    }
}