zarrs_metadata_ext 0.4.0

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

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

/// A wrapper to handle various versions of `vlen` codec configuration parameters.
#[derive(Serialize, Deserialize, Clone, Eq, PartialEq, Debug, Display, From)]
#[non_exhaustive]
#[serde(untagged)]
pub enum VlenCodecConfiguration {
    /// Version 0.1 draft.
    V0_1(VlenCodecConfigurationV0_1),
    /// Version 0.0 draft.
    V0(VlenCodecConfigurationV0),
}

impl ConfigurationSerialize for VlenCodecConfiguration {}

/// `vlen` codec configuration parameters (version 0.0 draft).
#[derive(Serialize, Deserialize, Clone, Eq, PartialEq, Debug, Display)]
#[serde(deny_unknown_fields)]
#[display("{}", serde_json::to_string(self).unwrap_or_default())]
pub struct VlenCodecConfigurationV0 {
    /// Encoding for the variable length indices (offsets).
    pub index_codecs: Vec<MetadataV3>,
    /// Encoding for the variable length data.
    pub data_codecs: Vec<MetadataV3>,
    /// The index data type.
    pub index_data_type: VlenIndexDataType,
}

/// `vlen` codec configuration parameters (version 0.1 draft).
#[derive(Serialize, Deserialize, Clone, Eq, PartialEq, Debug, Display)]
#[serde(deny_unknown_fields)]
#[display("{}", serde_json::to_string(self).unwrap_or_default())]
pub struct VlenCodecConfigurationV0_1 {
    /// Encoding for the variable length indices (offsets).
    pub index_codecs: Vec<MetadataV3>,
    /// Encoding for the variable length data.
    pub data_codecs: Vec<MetadataV3>,
    /// The index data type.
    pub index_data_type: VlenIndexDataType,
    /// The index location.
    pub index_location: VlenIndexLocation,
}

/// The `vlen` index location.
#[derive(Serialize, Deserialize, Clone, Copy, Eq, PartialEq, Debug, Display)]
#[serde(rename_all = "lowercase")]
pub enum VlenIndexLocation {
    /// The index is at the start of the chunk.
    Start,
    /// The index is at the end of the chunk.
    End,
}

/// Data types for variable length chunk data indices.
#[derive(Serialize, Deserialize, Clone, Copy, Eq, PartialEq, Debug, Display)]
#[serde(rename_all = "lowercase")]
pub enum VlenIndexDataType {
    // /// `uint8` Integer in `[0, 2^8-1]`.
    // UInt8,
    // /// `uint16` Integer in `[0, 2^16-1]`.
    // UInt16,
    /// `uint32` Integer in `[0, 2^32-1]`.
    UInt32,
    /// `uint64` Integer in `[0, 2^64-1]`.
    UInt64,
}

impl VlenCodecConfigurationV0 {
    /// Create a new `vlen` codec configuration.
    #[must_use]
    pub fn new(
        index_codecs: Vec<MetadataV3>,
        data_codecs: Vec<MetadataV3>,
        index_data_type: VlenIndexDataType,
    ) -> Self {
        Self {
            index_codecs,
            data_codecs,
            index_data_type,
        }
    }
}

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

    #[test]
    fn codec_vlen_simple_v0_0() {
        serde_json::from_str::<VlenCodecConfiguration>(
            r#"{
            "data_codecs": [{"name": "bytes"}],
            "index_codecs": [{"name": "bytes","configuration": { "endian": "little" }}],
            "index_data_type": "uint32"
        }"#,
        )
        .unwrap();
    }

    #[test]
    fn codec_vlen_simple_v0_1_start() {
        serde_json::from_str::<VlenCodecConfiguration>(
            r#"{
            "data_codecs": [{"name": "bytes"}],
            "index_codecs": [{"name": "bytes","configuration": { "endian": "little" }}],
            "index_data_type": "uint32",
            "index_location": "start"
        }"#,
        )
        .unwrap();
    }

    #[test]
    fn codec_vlen_compressed() {
        serde_json::from_str::<VlenCodecConfiguration>(r#"{
            "data_codecs": [{"name": "bytes"},{"name": "blosc","configuration": {"cname": "zstd", "clevel":5,"shuffle": "bitshuffle", "typesize":1,"blocksize":0}}],
            "index_codecs": [{"name": "bytes","configuration": { "endian": "little" }},{"name": "blosc","configuration":{"cname": "zstd", "clevel":5,"shuffle": "shuffle", "typesize":4,"blocksize":0}}],
            "index_data_type": "uint32",
            "index_location": "end"
        }"#).unwrap();
    }
}