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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
use std::fmt::{self, Display};
use std::io::{self, Write};
use std::ops::Index;

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

use super::parse::parse_tag_ref;
use super::ParsePicaError;

/// The level (main, local, copy) of a field (or tag).
#[derive(Debug, Default, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum Level {
    #[default]
    Main,
    Local,
    Copy,
}

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

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

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

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

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

    /// Returns the [Level] of the [TagRef].
    ///
    /// ```rust
    /// use pica_record::primitives::{Level, TagRef};
    ///
    /// assert_eq!(TagRef::new("003@")?.level(), Level::Main);
    /// assert_eq!(TagRef::new("101@")?.level(), Level::Local);
    /// assert_eq!(TagRef::new("203@")?.level(), Level::Copy);
    ///
    /// # Ok::<(), Box<dyn std::error::Error>>(())
    /// ```
    pub fn level(&self) -> Level {
        match self.0[0] {
            b'0' => Level::Main,
            b'1' => Level::Local,
            b'2' => Level::Copy,
            _ => unreachable!(),
        }
    }

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

impl Index<usize> for TagRef<'_> {
    type Output = u8;

    /// Access certain positions (indexed from zero) of a [TagRef].
    ///
    /// # Panics
    ///
    /// This functions panics of the position is greater than three.
    ///
    /// # Example
    ///
    /// ```rust
    /// use pica_record::primitives::TagRef;
    ///
    /// let tag = TagRef::new("003@")?;
    /// assert_eq!(tag[0], b'0');
    /// assert_eq!(tag[1], b'0');
    /// assert_eq!(tag[2], b'3');
    /// assert_eq!(tag[3], b'@');
    ///
    /// # Ok::<(), Box<dyn std::error::Error>>(())
    /// ```
    #[inline]
    fn index(&self, index: usize) -> &Self::Output {
        debug_assert!(index < self.0.len());
        &self.0[index]
    }
}

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

impl PartialEq<&str> for &TagRef<'_> {
    /// Compare a [TagRef] reference with a string slice.
    ///
    /// # Example
    ///
    /// ```rust
    /// use pica_record::primitives::TagRef;
    ///
    /// let tag = TagRef::new("003@")?;
    /// assert_eq!(&tag, "003@");
    ///
    /// # Ok::<(), Box<dyn std::error::Error>>(())
    /// ```
    #[inline]
    fn eq(&self, other: &&str) -> bool {
        self.0 == other.as_bytes()
    }
}

/// A mutable tag.
#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct Tag(BString);

impl Tag {
    /// Create a new [Tag].
    ///
    /// # Errors
    ///
    /// This function returns an error if the given tag is invalid.
    ///
    /// # Example
    ///
    /// ```rust
    /// use pica_record::primitives::Tag;
    ///
    /// let tag = Tag::new("003@")?;
    /// assert_eq!(tag, "003@");
    ///
    /// # Ok::<(), Box<dyn std::error::Error>>(())
    /// ```
    pub fn new(tag: &str) -> Result<Self, ParsePicaError> {
        Ok(Self::from(TagRef::new(tag)?))
    }

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

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

impl From<TagRef<'_>> for Tag {
    /// Create a new [Tag] from a [TagRef].
    ///
    /// # Example
    ///
    /// ```rust
    /// use pica_record::primitives::{Tag, TagRef};
    ///
    /// let tag_ref = TagRef::new("003@")?;
    /// let tag = Tag::from(tag_ref);
    /// assert_eq!(tag, "003@");
    ///
    /// # Ok::<(), Box<dyn std::error::Error>>(())
    /// ```
    fn from(tag: TagRef<'_>) -> Self {
        let TagRef(value) = tag;
        Self(value.into())
    }
}

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

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

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

impl Display for Tag {
    /// Formats the tag as a human-readable string.
    ///
    /// # Example
    ///
    /// ```rust
    /// use pica_record::primitives::Tag;
    ///
    /// let tag = Tag::new("003@")?;
    /// assert_eq!(tag.to_string(), "003@");
    ///
    /// # Ok::<(), Box<dyn std::error::Error>>(())
    /// ```
    #[inline]
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.0)
    }
}

#[cfg(test)]
impl quickcheck::Arbitrary for Tag {
    fn arbitrary(g: &mut quickcheck::Gen) -> Self {
        let p0 = *g.choose(b"012").unwrap();
        let p1 = *g.choose(b"0123456789").unwrap();
        let p2 = *g.choose(b"0123456789").unwrap();
        let p3 = *g.choose(b"ABCDEFGHIJKLMNOPQRSTUVWXYZ@").unwrap();

        Self(BString::from(&[p0, p1, p2, p3]))
    }
}