zarrs_metadata_ext 0.1.1

Zarr extensions metadata support for the zarrs crate
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

use derive_more::{Display, From};
use serde::{Deserialize, Serialize};

use zarrs_metadata::ConfigurationSerialize;

/// A wrapper to handle various versions of `fletcher32` codec configuration parameters.
#[derive(Serialize, Deserialize, Clone, Eq, PartialEq, Debug, Display, From)]
#[non_exhaustive]
#[serde(untagged)]
pub enum Fletcher32CodecConfiguration {
    /// Version 1.0 draft.
    V1(Fletcher32CodecConfigurationV1),
}

impl ConfigurationSerialize for Fletcher32CodecConfiguration {}

/// `fletcher32` codec configuration parameters (version 1.0 draft).
///
/// ### Example (Zarr V3)
/// ```json
/// {
///     "name": "fletcher32",
///     "configuration": {}
/// }
/// ```
#[derive(Serialize, Deserialize, Clone, Eq, PartialEq, Debug, Display)]
// TODO: deny_unknown_fields could be disabled to support numcodecs, which adds "id": "fletcher32"
//       However, I would rather be intentionally incompatible and push forward with standardisation instead
#[serde(deny_unknown_fields)]
#[display("{}", serde_json::to_string(self).unwrap_or_default())]
pub struct Fletcher32CodecConfigurationV1 {}

#[cfg(test)]
mod tests {
    use zarrs_metadata::v3::MetadataV3;

    use super::*;

    #[test]
    fn codec_fletcher32_config1() {
        serde_json::from_str::<Fletcher32CodecConfiguration>(r#"{}"#).unwrap();
    }

    #[test]
    fn codec_fletcher32_config_outer1() {
        serde_json::from_str::<MetadataV3>(
            r#"{
            "name": "fletcher32",
            "configuration": {}
        }"#,
        )
        .unwrap();
    }

    #[test]
    fn codec_fletcher32_config_outer2() {
        serde_json::from_str::<MetadataV3>(
            r#"{
            "name": "fletcher32"
        }"#,
        )
        .unwrap();
    }
}