zarrs 0.23.9

A library for the Zarr storage format for multidimensional arrays and metadata
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

use std::num::NonZeroU64;

use derive_more::From;
use serde::Serialize;

use crate::array::{ArrayCreateError, ArrayShape, ChunkShape};
use zarrs_metadata::v3::MetadataV3;
use zarrs_metadata_ext::chunk_grid::regular::RegularChunkGridConfiguration;

/// An input that can be mapped to a chunk grid.
#[derive(Debug, Clone, From)]
pub struct ArrayBuilderChunkGridMetadata(ArrayBuilderChunkGridMetadataImpl);

#[derive(Debug, Clone, From)]
enum ArrayBuilderChunkGridMetadataImpl {
    Metadata(MetadataV3),
    MetadataString(String),
    ArrayShape(ArrayShape),
    ChunkShape(ChunkShape),
}

impl ArrayBuilderChunkGridMetadata {
    pub(crate) fn to_metadata(&self) -> Result<MetadataV3, ArrayCreateError> {
        match &self.0 {
            ArrayBuilderChunkGridMetadataImpl::Metadata(metadata) => Ok(metadata.clone()),
            ArrayBuilderChunkGridMetadataImpl::MetadataString(metadata) => {
                let metadata = MetadataV3::try_from(metadata.as_str()).map_err(|_| {
                    ArrayCreateError::ChunkGridCreateError(zarrs_plugin::PluginCreateError::from(
                        "chunk grid string cannot be parsed as metadata",
                    ))
                })?;
                Ok(metadata)
            }
            ArrayBuilderChunkGridMetadataImpl::ArrayShape(chunk_shape) => {
                #[derive(Serialize)]
                struct RegularChunkGridConfiguration {
                    chunk_shape: ArrayShape,
                }
                let metadata = MetadataV3::new_with_serializable_configuration(
                    "regular".to_string(),
                    &RegularChunkGridConfiguration {
                        chunk_shape: chunk_shape.clone(),
                    },
                )
                .expect("RegularChunkGridConfigurationInvalid is serialisable");
                Ok(metadata)
            }
            ArrayBuilderChunkGridMetadataImpl::ChunkShape(chunk_shape) => {
                let metadata = MetadataV3::new_with_serializable_configuration(
                    "regular".to_string(),
                    &RegularChunkGridConfiguration {
                        chunk_shape: chunk_shape.clone(),
                    },
                )
                .expect("RegularChunkGridConfigurationInvalid is serialisable");
                Ok(metadata)
            }
        }
    }
}

impl From<MetadataV3> for ArrayBuilderChunkGridMetadata {
    fn from(value: MetadataV3) -> Self {
        Self(ArrayBuilderChunkGridMetadataImpl::Metadata(value))
    }
}

impl From<String> for ArrayBuilderChunkGridMetadata {
    fn from(value: String) -> Self {
        Self(ArrayBuilderChunkGridMetadataImpl::MetadataString(value))
    }
}

impl From<&str> for ArrayBuilderChunkGridMetadata {
    fn from(value: &str) -> Self {
        Self(ArrayBuilderChunkGridMetadataImpl::MetadataString(
            value.to_string(),
        ))
    }
}

impl<const N: usize> From<[u64; N]> for ArrayBuilderChunkGridMetadata {
    fn from(chunk_shape: [u64; N]) -> Self {
        Self(ArrayBuilderChunkGridMetadataImpl::ArrayShape(
            chunk_shape.to_vec(),
        ))
    }
}

impl<const N: usize> From<&[u64; N]> for ArrayBuilderChunkGridMetadata {
    fn from(chunk_shape: &[u64; N]) -> Self {
        Self(ArrayBuilderChunkGridMetadataImpl::ArrayShape(
            chunk_shape.to_vec(),
        ))
    }
}

impl From<&[u64]> for ArrayBuilderChunkGridMetadata {
    fn from(chunk_shape: &[u64]) -> Self {
        Self(ArrayBuilderChunkGridMetadataImpl::ArrayShape(
            chunk_shape.to_vec(),
        ))
    }
}

impl<const N: usize> From<[NonZeroU64; N]> for ArrayBuilderChunkGridMetadata {
    fn from(chunk_shape: [NonZeroU64; N]) -> Self {
        Self(ArrayBuilderChunkGridMetadataImpl::ChunkShape(
            chunk_shape.to_vec(),
        ))
    }
}

impl<const N: usize> From<&[NonZeroU64; N]> for ArrayBuilderChunkGridMetadata {
    fn from(chunk_shape: &[NonZeroU64; N]) -> Self {
        Self(ArrayBuilderChunkGridMetadataImpl::ChunkShape(
            chunk_shape.to_vec(),
        ))
    }
}

impl From<&[NonZeroU64]> for ArrayBuilderChunkGridMetadata {
    fn from(chunk_shape: &[NonZeroU64]) -> Self {
        Self(ArrayBuilderChunkGridMetadataImpl::ChunkShape(
            chunk_shape.to_vec(),
        ))
    }
}

impl From<Vec<NonZeroU64>> for ArrayBuilderChunkGridMetadata {
    fn from(chunk_shape: Vec<NonZeroU64>) -> Self {
        Self(ArrayBuilderChunkGridMetadataImpl::ChunkShape(chunk_shape))
    }
}

impl From<Vec<u64>> for ArrayBuilderChunkGridMetadata {
    fn from(chunk_shape: Vec<u64>) -> Self {
        Self(ArrayBuilderChunkGridMetadataImpl::ArrayShape(chunk_shape))
    }
}