zarrs_metadata_ext 0.4.4

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
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

//! `optional` codec metadata (`zarrs` experimental).

use derive_more::{Display, From};
use serde::{Deserialize, Serialize};
use zarrs_metadata::v3::MetadataV3;
use zarrs_metadata::ConfigurationSerialize;

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

impl ConfigurationSerialize for OptionalCodecConfiguration {}

/// `optional` codec configuration parameters (version 1.0 draft).
///
/// ### Example (Zarr V3)
/// ```json
/// {
///     "name": "optional",
///     "configuration": {
///         "mask_codecs": [
///             {
///                 "name": "packbits",
///                 "configuration": {}
///             },
///             {
///                 "name": "gzip",
///                 "configuration": {"level": 5}
///             }
///         ],
///         "data_codecs": [
///             {
///                 "name": "bytes",
///                 "configuration": {"endian": "little"}
///             },
///             {
///                 "name": "gzip",
///                 "configuration": {"level": 5}
///             }
///         ]
///     }
/// }
/// ```
#[derive(Serialize, Deserialize, Clone, Eq, PartialEq, Debug, Display)]
#[serde(deny_unknown_fields)]
#[display("{}", serde_json::to_string(self).unwrap_or_default())]
pub struct OptionalCodecConfigurationV1 {
    /// The codec chain for encoding/decoding the mask (flattened bool array).
    pub mask_codecs: Vec<MetadataV3>,
    /// The codec chain for encoding/decoding the data (flattened bytes, excluding missing elements).
    pub data_codecs: Vec<MetadataV3>,
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn optional_simple() {
        let configuration = serde_json::from_str::<OptionalCodecConfigurationV1>(
            r#"
        {
            "mask_codecs": [
                {
                    "name": "packbits",
                    "configuration": {}
                }
            ],
            "data_codecs": [
                {
                    "name": "bytes",
                    "configuration": {}
                }
            ]
        }
        "#,
        )
        .unwrap();
        assert_eq!(configuration.mask_codecs.len(), 1);
        assert_eq!(configuration.data_codecs.len(), 1);
    }

    #[test]
    fn optional_with_compression() {
        let configuration = serde_json::from_str::<OptionalCodecConfigurationV1>(
            r#"
        {
            "mask_codecs": [
                {
                    "name": "packbits",
                    "configuration": {}
                },
                {
                    "name": "gzip",
                    "configuration": {"level": 5}
                }
            ],
            "data_codecs": [
                {
                    "name": "bytes",
                    "configuration": {"endian": "little"}
                },
                {
                    "name": "gzip",
                    "configuration": {"level": 5}
                }
            ]
        }
        "#,
        )
        .unwrap();
        assert_eq!(configuration.mask_codecs.len(), 2);
        assert_eq!(configuration.data_codecs.len(), 2);
    }

    #[test]
    fn optional_missing_mask_codecs() {
        let config = r#"
        {
            "data_codecs": []
        }
        "#;
        assert!(serde_json::from_str::<OptionalCodecConfigurationV1>(config).is_err());
    }

    #[test]
    fn optional_missing_data_codecs() {
        let config = r#"
        {
            "mask_codecs": []
        }
        "#;
        assert!(serde_json::from_str::<OptionalCodecConfigurationV1>(config).is_err());
    }
}