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
//! Implementation of the string schema

use crate::{DataSchema, Decoder, Encoder, Error, IntegerSchema, Result};
use byteorder::{ReadBytesExt, WriteBytesExt};
use serde::de::{Deserializer, Error as DeError};
use serde::Deserialize;
use serde_json::Value;
use std::convert::TryFrom;
use std::io;

#[derive(Debug, Clone, Deserialize)]
#[serde(tag = "type", rename_all = "lowercase")]
enum LengthEncoding {
    /// Requires `"minItems"` and  `"maxItems"` set to the same value.
    /// All array have that many entries. If there are more or less entries to
    /// encode an error is raised.
    Fixed { length: usize },
    /// The number of entries in the array is stored as the beginning using the
    /// given integer schema.
    ExplicitLength(IntegerSchema),
}

/// How is the length of variable sized data encoded.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
struct RawArray {
    length_encoding: Option<IntegerSchema>,
    max_items: Option<usize>,
    min_items: Option<usize>,
    items: DataSchema,
}

/// The array schema to describe arrays of homogeneous elements.
///
/// Contrary to the JSON schema's array schema tuples are not supported.
#[derive(Debug, Clone)]
pub struct ArraySchema {
    length: LengthEncoding,
    items: DataSchema,
}

impl ArraySchema {
    fn valid_slice<T: std::fmt::Debug>(&self, slice: &[T]) -> Result<()> {
        match &self.length {
            LengthEncoding::Fixed { length } => {
                if slice.len() != *length {
                    Err(Error::NotMatchFixedLength {
                        value: format!("{:?}", slice),
                        len: slice.len(),
                        fixed: *length,
                    })
                } else {
                    Ok(())
                }
            }
            LengthEncoding::ExplicitLength(schema) => {
                if schema.max_value() < slice.len() {
                    Err(Error::ExceededLengthEncoding {
                        value: format!("{:?}", slice),
                        len: slice.len(),
                        max: schema.max_value(),
                    })
                } else {
                    Ok(())
                }
            }
        }
    }
}

impl TryFrom<RawArray> for ArraySchema {
    type Error = Error;

    fn try_from(raw: RawArray) -> Result<Self, Self::Error> {
        let length = match (raw.min_items, raw.max_items, raw.length_encoding) {
            (Some(min), Some(max), None) if min == max => LengthEncoding::Fixed { length: max },
            (_, _, None) => return Err(Error::MissingArrayLength),
            (_, _, Some(schema)) => LengthEncoding::ExplicitLength(schema),
        };

        Ok(Self {
            length,
            items: raw.items,
        })
    }
}

impl<'de> Deserialize<'de> for ArraySchema {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        let raw = RawArray::deserialize(deserializer)?;
        ArraySchema::try_from(raw).map_err(D::Error::custom)
    }
}

impl Encoder for ArraySchema {
    fn encode<W>(&self, target: &mut W, value: &Value) -> Result<usize>
    where
        W: io::Write + WriteBytesExt,
    {
        let value = value.as_array().ok_or_else(|| Error::InvalidValue {
            value: value.to_string(),
            type_: "array",
        })?;
        self.valid_slice(value)?;

        let mut written = match &self.length {
            LengthEncoding::Fixed { .. } => 0,
            LengthEncoding::ExplicitLength(len_schema) => {
                let len = value.len().into();
                len_schema.encode(target, &len)?
            }
        };
        for v in value.iter() {
            written += self.items.encode(target, v)?;
        }
        Ok(written)
    }
}

impl Decoder for ArraySchema {
    fn decode<R>(&self, target: &mut R) -> Result<Value>
    where
        R: io::Read + ReadBytesExt,
    {
        let len = match &self.length {
            LengthEncoding::Fixed { length } => *length,
            LengthEncoding::ExplicitLength(lenght_dec) => lenght_dec
                .decode(target)?
                .as_u64()
                .expect("counts are always unsigned ints")
                as _,
        };

        let elements: Result<Vec<_>, _> = (0..len).map(|_| self.items.decode(target)).collect();
        Ok(elements?.into())
    }
}

#[cfg(test)]
mod test {
    use super::*;
    use anyhow::Result;
    use serde_json::{from_value, json};

    #[test]
    fn default() -> Result<()> {
        let schema = json!({});
        let schema = from_value::<ArraySchema>(schema);
        assert!(schema.is_err());
        Ok(())
    }
    #[test]
    fn schema_only() -> Result<()> {
        let schema = json!({
            "items": {
                "type": "boolean"
            }
        });
        let schema = from_value::<ArraySchema>(schema);
        assert!(schema.is_err());
        Ok(())
    }
    #[test]
    fn fixed() -> Result<()> {
        let schema = json!({
            "minItems": 2,
            "maxItems": 2,
            "items": {
                "type": "boolean"
            }
        });
        let schema = from_value::<ArraySchema>(schema)?;
        assert!(matches!(schema, ArraySchema {length: LengthEncoding::Fixed {..}, ..}));

        let value = json!([false, true]);
        let mut buffer = vec![];
        assert_eq!(2, schema.encode(&mut buffer, &value)?);
        let expected: [u8; 2] = [0, 1];
        assert_eq!(&expected, buffer.as_slice());

        Ok(())
    }
    #[test]
    fn length() -> Result<()> {
        let schema = json!({
            "lengthEncoding": {
                "length": 1,
                "signed": false
            },
            "items": {
                "type": "boolean"
            }
        });
        let schema = from_value::<ArraySchema>(schema)?;
        assert!(matches!(schema, ArraySchema {length: LengthEncoding::ExplicitLength(_), ..}));

        let value = json!([false, true]);
        let mut buffer = vec![];
        assert_eq!(3, schema.encode(&mut buffer, &value)?);
        let expected: [u8; 3] = [2, 0, 1];
        assert_eq!(&expected, buffer.as_slice());

        Ok(())
    }
}