Enum FillValueMetadata

Source

pub enum FillValueMetadata {
    Null,
    Bool(bool),
    Number(Number),
    String(String),
    Array(Vec<FillValueMetadataV3>),
    Object(HashMap<String, FillValueMetadataV3>),
}

Expand description

Zarr V3 fill value metadata.

Variants§

§

Null

Represents a JSON null value.

§

Bool(bool)

Represents a JSON boolean.

§

Number(Number)

Represents a finite JSON number, whether integer or floating point.

§

String(String)

Represents a JSON string. This includes hex strings and non-finite float representations.

§

Array(Vec<FillValueMetadataV3>)

Represents a JSON array.

§

Object(HashMap<String, FillValueMetadataV3>)

Represents a JSON object.

Implementations§

Source §

impl FillValueMetadataV3

Source

pub fn is_null(&self) -> bool

Returns true if the value is a null. Returns false otherwise.

Examples found in repository ?

examples/custom_data_type_variable_size.rs (line 124)

117    fn fill_value(
118        &self,
119        fill_value_metadata: &FillValueMetadata,
120        _version: ZarrVersion,
121    ) -> Result<FillValue, DataTypeFillValueMetadataError> {
122        if let Some(f) = fill_value_metadata.as_f32() {
123            Ok(FillValue::new(f.to_ne_bytes().to_vec()))
124        } else if fill_value_metadata.is_null() {
125            Ok(FillValue::new(vec![]))
126        } else if let Some(bytes) = fill_value_metadata.as_bytes() {
127            Ok(FillValue::new(bytes))
128        } else {
129            Err(DataTypeFillValueMetadataError)
130        }
131    }

Source

pub fn as_null(&self) -> Option<()>

If the value is a Null, returns (). Returns None otherwise.

Source

pub fn as_str(&self) -> Option<&str>

If the value is a string, returns the associated str. Returns None otherwise.

Source

pub fn as_bytes(&self) -> Option<Vec<u8>>

Returns a vector of bytes if the value is an array of integers in [0, 255].

Examples found in repository ?

examples/custom_data_type_variable_size.rs (line 126)

117    fn fill_value(
118        &self,
119        fill_value_metadata: &FillValueMetadata,
120        _version: ZarrVersion,
121    ) -> Result<FillValue, DataTypeFillValueMetadataError> {
122        if let Some(f) = fill_value_metadata.as_f32() {
123            Ok(FillValue::new(f.to_ne_bytes().to_vec()))
124        } else if fill_value_metadata.is_null() {
125            Ok(FillValue::new(vec![]))
126        } else if let Some(bytes) = fill_value_metadata.as_bytes() {
127            Ok(FillValue::new(bytes))
128        } else {
129            Err(DataTypeFillValueMetadataError)
130        }
131    }

Source

pub fn as_array(&self) -> Option<&[FillValueMetadataV3]>

If the value is an array, returns the associated elements. Returns None otherwise.

Source

pub fn as_object(&self) -> Option<HashMap<String, FillValueMetadataV3>>

If the value is an object, returns the associated HashMap. Returns None otherwise.

Source

pub fn as_bool(&self) -> Option<bool>

If the value is a Boolean, returns the associated bool. Returns None otherwise.

Source

pub fn as_bf16(&self) -> Option<bf16>

If the value is a number or non-finite float representation, represent it as bf16 if possible. Returns None otherwise.

Source

pub fn as_f16(&self) -> Option<f16>

If the value is a number or non-finite float representation, represent it as f16 if possible. Returns None otherwise.

Source

pub fn as_f32(&self) -> Option<f32>

If the value is a number or non-finite float representation, represent it as f32 if possible. Returns None otherwise.

Examples found in repository ?

examples/custom_data_type_float8_e3m4.rs (line 60)

54    fn fill_value(
55        &self,
56        fill_value_metadata: &FillValueMetadata,
57        _version: ZarrVersion,
58    ) -> Result<FillValue, DataTypeFillValueMetadataError> {
59        let element_metadata: f32 = fill_value_metadata
60            .as_f32()
61            .ok_or(DataTypeFillValueMetadataError)?;
62        let element = CustomDataTypeFloat8e3m4Element::from(element_metadata);
63        Ok(FillValue::new(element.into_ne_bytes().to_vec()))
64    }

More examples

Hide additional examples

examples/custom_data_type_variable_size.rs (line 122)

117    fn fill_value(
118        &self,
119        fill_value_metadata: &FillValueMetadata,
120        _version: ZarrVersion,
121    ) -> Result<FillValue, DataTypeFillValueMetadataError> {
122        if let Some(f) = fill_value_metadata.as_f32() {
123            Ok(FillValue::new(f.to_ne_bytes().to_vec()))
124        } else if fill_value_metadata.is_null() {
125            Ok(FillValue::new(vec![]))
126        } else if let Some(bytes) = fill_value_metadata.as_bytes() {
127            Ok(FillValue::new(bytes))
128        } else {
129            Err(DataTypeFillValueMetadataError)
130        }
131    }

Source

pub fn as_f64(&self) -> Option<f64>

If the value is a number or non-finite float representation, represent it as f64 if possible. Returns None otherwise.

Source

pub fn as_u64(&self) -> Option<u64>

If the value is an integer, represent it as u64 if possible. Returns None otherwise.

Examples found in repository ?

examples/custom_data_type_uint4.rs (line 61)

55    fn fill_value(
56        &self,
57        fill_value_metadata: &FillValueMetadata,
58        _version: ZarrVersion,
59    ) -> Result<FillValue, DataTypeFillValueMetadataError> {
60        let element_metadata: u64 = fill_value_metadata
61            .as_u64()
62            .ok_or(DataTypeFillValueMetadataError)?;
63        let element = CustomDataTypeUInt4Element::try_from(element_metadata)
64            .map_err(|_| DataTypeFillValueMetadataError)?;
65        Ok(FillValue::new(element.into_ne_bytes().to_vec()))
66    }

More examples

Hide additional examples

examples/custom_data_type_uint12.rs (line 59)

53    fn fill_value(
54        &self,
55        fill_value_metadata: &FillValueMetadata,
56        _version: ZarrVersion,
57    ) -> Result<FillValue, DataTypeFillValueMetadataError> {
58        let element_metadata: u64 = fill_value_metadata
59            .as_u64()
60            .ok_or(DataTypeFillValueMetadataError)?;
61        let element = CustomDataTypeUInt12Element::try_from(element_metadata)
62            .map_err(|_| DataTypeFillValueMetadataError)?;
63        Ok(FillValue::new(element.into_le_bytes().to_vec()))
64    }

Source

pub fn as_i64(&self) -> Option<i64>

If the value is an integer, represent it as i64 if possible. Returns None otherwise.

Source

pub fn as_custom<T>(&self) -> Option<T>
where T: DeserializeOwned,

Convert fill value metadata to a custom structure.

Examples found in repository ?

examples/custom_data_type_fixed_size.rs (line 187)

181    fn fill_value(
182        &self,
183        fill_value_metadata: &FillValueMetadata,
184        _version: ZarrVersion,
185    ) -> Result<FillValue, DataTypeFillValueMetadataError> {
186        let element_metadata: CustomDataTypeFixedSizeMetadata = fill_value_metadata
187            .as_custom()
188            .ok_or(DataTypeFillValueMetadataError)?;
189        Ok(FillValue::new(element_metadata.to_ne_bytes().to_vec()))
190    }

Trait Implementations§

Source §

impl Clone for FillValueMetadataV3

Source §

fn clone(&self) -> FillValueMetadataV3

Returns a duplicate of the value. Read more

1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

Source §

impl Debug for FillValueMetadataV3

Source §

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more

Source §

impl<'de> Deserialize<'de> for FillValueMetadataV3

Source §

fn deserialize<D>( deserializer: D, ) -> Result<FillValueMetadataV3, <D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

Source §

impl Display for FillValueMetadataV3

Source §

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more

Source §