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
use std::io::{self, Write};
use std::str::Utf8Error;

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

use super::parse::parse_record_ref;
use super::{Field, FieldRef, ParsePicaError};

/// An immutable PICA+ record.
#[derive(Debug, PartialEq, Clone)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct RecordRef<'a>(
    #[cfg_attr(feature = "serde", serde(borrow))]
    pub(super)  Vec<FieldRef<'a>>,
);

impl<'a> RecordRef<'a> {
    /// Creates a new [RecordRef].
    ///
    /// # Errors
    ///
    /// This function fails if either the tag, occcurrence or any
    /// subfield is nvalid.
    ///
    /// # Example
    ///
    /// ```rust
    /// use pica_record::primitives::RecordRef;
    ///
    /// let record = RecordRef::new(vec![
    ///     ("003@", None, vec![('0', "123456789X")]),
    ///     ("002@", None, vec![('0', "Tp1")]),
    /// ])?;
    ///
    /// assert_eq!(record.fields().len(), 2);
    ///
    /// # Ok::<(), Box<dyn std::error::Error>>(())
    /// ```
    pub fn new<T>(
        fields: Vec<(&'a str, Option<&'a str>, T)>,
    ) -> Result<Self, ParsePicaError>
    where
        T: IntoIterator<Item = (char, &'a str)>,
    {
        let fields = fields
            .into_iter()
            .map(|(tag, occ, subfields)| {
                FieldRef::new(tag, occ, subfields)
            })
            .collect::<Result<Vec<FieldRef<'a>>, _>>()?;

        Ok(Self(fields))
    }

    /// Creates a new [RecordRef] from a byte slice.
    ///
    /// # Example
    ///
    /// ```rust
    /// use pica_record::primitives::RecordRef;
    ///
    /// let record = RecordRef::from_bytes(b"012A \x1f0abc\x1e\n")?;
    /// assert_eq!(record.fields().len(), 1);
    ///
    /// # Ok::<(), Box<dyn std::error::Error>>(())
    /// ```
    pub fn from_bytes<B>(record: &'a B) -> Result<Self, ParsePicaError>
    where
        B: AsRef<[u8]> + ?Sized,
    {
        let bytes = record.as_ref();

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

    /// Returns the fields of the record.
    ///
    /// # Example
    ///
    /// ```rust
    /// use pica_record::primitives::{FieldRef, RecordRef};
    ///
    /// let record = RecordRef::from_bytes(b"012A \x1f0abc\x1e\n")?;
    /// let field = FieldRef::from_bytes(b"012A \x1f0abc\x1e")?;
    /// assert_eq!(record.fields(), [field]);
    ///
    /// # Ok::<(), Box<dyn std::error::Error>>(())
    /// ```
    #[inline]
    pub fn fields(&self) -> &[FieldRef<'a>] {
        &self.0
    }

    /// Returns `true` if the [RecordRef] contains no fields, otherwise
    /// `false`.
    ///
    /// # Example
    ///
    /// ```rust
    /// use pica_record::primitives::RecordRef;
    ///
    /// let record = RecordRef::from_bytes(b"002@ \x1f0Oaf\x1e\n")?;
    /// assert!(!record.is_empty());
    ///
    /// # Ok::<(), Box<dyn std::error::Error>>(())
    /// ```
    #[inline]
    pub fn is_empty(&self) -> bool {
        self.0.is_empty()
    }

    /// Retains only the [FieldRef]s specified by the predicate.
    ///
    ///
    /// # Example
    ///
    /// ```rust
    /// use pica_record::primitives::RecordRef;
    ///
    /// let mut record = RecordRef::new(vec![
    ///     ("003@", None, vec![('0', "123456789X")]),
    ///     ("002@", None, vec![('0', "Oaf")]),
    /// ])?;
    ///
    /// assert_eq!(record.fields().len(), 2);
    ///
    /// record.retain(|field| field.tag() == "003@");
    /// assert_eq!(record.fields().len(), 1);
    ///
    /// # Ok::<(), Box<dyn std::error::Error>>(())
    /// ```
    #[inline]
    pub fn retain<F: FnMut(&FieldRef) -> bool>(&mut self, f: F) {
        self.0.retain(f);
    }

    /// Returns an [`std::str::Utf8Error`](Utf8Error) if the record
    /// contains invalid UTF-8 data, otherwise the unit.
    ///
    /// # Example
    ///
    /// ```rust
    /// use pica_record::primitives::RecordRef;
    ///
    /// let record = RecordRef::from_bytes(b"003@ \x1f0a\x1e\n")?;
    /// assert!(record.validate().is_ok());
    ///
    /// # Ok::<(), Box<dyn std::error::Error>>(())
    /// ```
    pub fn validate(&self) -> Result<(), Utf8Error> {
        for field in self.fields() {
            field.validate()?;
        }

        Ok(())
    }

    /// Write the [RecordRef] into the given writer.
    ///
    /// # Example
    ///
    /// ```rust
    /// use std::io::Cursor;
    ///
    /// use pica_record::primitives::RecordRef;
    ///
    /// let mut writer = Cursor::new(Vec::<u8>::new());
    /// let record = RecordRef::from_bytes(b"003@ \x1f0a\x1e\n")?;
    /// record.write_to(&mut writer);
    ///
    /// assert_eq!(
    ///     String::from_utf8(writer.into_inner())?,
    ///     "003@ \x1f0a\x1e\n"
    /// );
    ///
    /// # Ok::<(), Box<dyn std::error::Error>>(())
    /// ```
    #[inline]
    pub fn write_to(&self, out: &mut impl Write) -> io::Result<()> {
        if !self.is_empty() {
            for field in self.fields() {
                field.write_to(out)?;
            }

            writeln!(out)?;
        }

        Ok(())
    }
}

/// A mutable record.
#[derive(Debug, Clone)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct Record(Vec<Field>);

impl Record {
    /// Write the record into the given writer.
    ///
    /// # Example
    ///
    /// ```rust
    /// use std::io::Cursor;
    ///
    /// use pica_record::primitives::{Record, RecordRef};
    ///
    /// let mut writer = Cursor::new(Vec::<u8>::new());
    /// let record: Record =
    ///     RecordRef::from_bytes(b"003@ \x1f0a\x1e\n")?.into();
    /// record.write_to(&mut writer);
    ///
    /// assert_eq!(
    ///     String::from_utf8(writer.into_inner())?,
    ///     "003@ \x1f0a\x1e\n"
    /// );
    ///
    /// # Ok::<(), Box<dyn std::error::Error>>(())
    /// ```
    #[inline]
    pub fn write_to(&self, out: &mut impl Write) -> io::Result<()> {
        if !self.0.is_empty() {
            for field in self.0.iter() {
                field.write_to(out)?;
            }

            writeln!(out)?;
        }

        Ok(())
    }
}

impl From<RecordRef<'_>> for Record {
    /// Converts a [RecordRef] into a [Record].
    ///
    /// # Example
    ///
    /// ```rust
    /// use pica_record::primitives::{Record, RecordRef};
    ///
    /// let record_ref = RecordRef::from_bytes(b"003@ \x1f0a\x1e\n")?;
    /// let record = Record::from(record_ref);
    /// assert_eq!(RecordRef::from_bytes(b"003@ \x1f0a\x1e\n")?, record);
    ///
    /// # Ok::<(), Box<dyn std::error::Error>>(())
    /// ```
    #[inline]
    fn from(record: RecordRef<'_>) -> Self {
        Self(record.0.into_iter().map(Field::from).collect())
    }
}

impl PartialEq<Record> for RecordRef<'_> {
    fn eq(&self, other: &Record) -> bool {
        self.0 == other.0
    }
}

impl PartialEq<RecordRef<'_>> for Record {
    fn eq(&self, other: &RecordRef<'_>) -> bool {
        self.0 == other.0
    }
}

#[cfg(test)]
impl quickcheck::Arbitrary for Record {
    fn arbitrary(g: &mut quickcheck::Gen) -> Self {
        let fields = (0..g.size())
            .map(|_| Field::arbitrary(g))
            .collect::<Vec<_>>();

        Self(fields)
    }
}