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

use crate::config::MetadataConvertVersion;
use zarrs_codec::CodecMetadataOptions;

/// Options for writing array metadata.
#[derive(Debug, Clone, Copy)]
pub struct ArrayMetadataOptions {
    codec_metadata_options: CodecMetadataOptions,
    convert_version: MetadataConvertVersion,
    include_zarrs_metadata: bool,
    convert_aliased_extension_names: bool,
}

impl Default for ArrayMetadataOptions {
    fn default() -> Self {
        Self {
            codec_metadata_options: CodecMetadataOptions::default(),
            convert_version: MetadataConvertVersion::Default,
            include_zarrs_metadata: true,
            convert_aliased_extension_names: false,
        }
    }
}

impl ArrayMetadataOptions {
    /// Return the codec options.
    #[must_use]
    pub fn codec_metadata_options(&self) -> &CodecMetadataOptions {
        &self.codec_metadata_options
    }

    /// Return a mutable reference to the codec options.
    #[must_use]
    pub fn codec_metadata_options_mut(&mut self) -> &mut CodecMetadataOptions {
        &mut self.codec_metadata_options
    }

    /// Set the codec metadata options.
    #[must_use]
    pub fn with_codec_metadata_options(
        mut self,
        codec_metadata_options: CodecMetadataOptions,
    ) -> Self {
        self.codec_metadata_options = codec_metadata_options;
        self
    }

    /// Set the codec metadata options.
    pub fn set_codec_metadata_options(
        &mut self,
        codec_metadata_options: CodecMetadataOptions,
    ) -> &mut Self {
        self.codec_metadata_options = codec_metadata_options;
        self
    }

    /// Get the [metadata convert version](crate::config::Config#metadata-convert-version) configuration.
    #[must_use]
    pub fn metadata_convert_version(&self) -> MetadataConvertVersion {
        self.convert_version
    }

    /// Set the [metadata convert version](crate::config::Config#metadata-convert-version) configuration.
    #[must_use]
    pub fn with_metadata_convert_version(
        mut self,
        convert_version: MetadataConvertVersion,
    ) -> Self {
        self.convert_version = convert_version;
        self
    }

    /// Set the [metadata convert version](crate::config::Config#metadata-convert-version) configuration.
    pub fn set_metadata_convert_version(
        &mut self,
        convert_version: MetadataConvertVersion,
    ) -> &mut Self {
        self.convert_version = convert_version;
        self
    }

    /// Get the [include zarrs metadata](crate::config::Config#include-zarrs-metadata) configuration.
    #[must_use]
    pub fn include_zarrs_metadata(&self) -> bool {
        self.include_zarrs_metadata
    }

    /// Set the [include zarrs metadata](crate::config::Config#include-zarrs-metadata) configuration.
    #[must_use]
    pub fn with_include_zarrs_metadata(mut self, include_zarrs_metadata: bool) -> Self {
        self.include_zarrs_metadata = include_zarrs_metadata;
        self
    }

    /// Set the [include zarrs metadata](crate::config::Config#include-zarrs-metadata) configuration.
    pub fn set_include_zarrs_metadata(&mut self, include_zarrs_metadata: bool) -> &mut Self {
        self.include_zarrs_metadata = include_zarrs_metadata;
        self
    }

    /// Return the [convert aliased extension names](crate::config::Config#convert-aliased-extension-names) configuration
    #[must_use]
    pub fn convert_aliased_extension_names(&self) -> bool {
        self.convert_aliased_extension_names
    }

    /// Set the [convert aliased extension names](crate::config::Config#convert-aliased-extension-names) configuration.
    #[must_use]
    pub fn with_convert_aliased_extension_names(
        mut self,
        convert_aliased_extension_names: bool,
    ) -> Self {
        self.convert_aliased_extension_names = convert_aliased_extension_names;
        self
    }

    /// Set the [convert aliased extension names](crate::config::Config#convert-aliased-extension-names) configuration.
    pub fn set_convert_aliased_extension_names(
        &mut self,
        convert_aliased_extension_names: bool,
    ) -> &mut Self {
        self.convert_aliased_extension_names = convert_aliased_extension_names;
        self
    }
}