Struct OptionalDataType 

pub struct OptionalDataType(/* private fields */);

The optional data type.

This wraps the inner DataType and provides methods specific to optional types, such as checking if a fill value represents null and extracting inner fill value bytes.

Use the explicit accessor methods (e.g., inner(), data_type()) to access the wrapped data type’s properties.

Implementations

impl OptionalDataType

pub fn new(inner: DataType) -> OptionalDataType

Create a new optional data type wrapper.

pub fn is_fill_value_null(&self, fill_value: &FillValue) -> bool

Check if the fill value represents null (last byte is 0x00).

pub fn fill_value_inner_bytes<'a>(&self, fill_value: &'a FillValue) -> &'a [u8]

Get the inner fill value bytes (without optional suffix).

For optional data types, returns all bytes except the last suffix byte.

pub fn configuration(&self, version: ZarrVersion) -> Configuration

Returns the configuration for this optional data type.

impl OptionalDataType

pub fn inner(&self) -> &DataType

Returns a reference to the inner data type.

pub fn into_inner(self) -> DataType

Returns the inner data type, consuming self.

pub fn data_type(&self) -> &DataType

The underlying inner data type.

pub fn inner_size(&self) -> DataTypeSize

The size of the inner data type.

pub fn is_fixed(&self) -> bool

Returns true if the inner data type is fixed size.

pub fn fixed_size(&self) -> Option<usize>

Returns the fixed size of the inner data type if it’s fixed size.

pub fn fill_value_from_metadata( &self, fill_value: &FillValueMetadataV3, version: ZarrVersion, ) -> Result<FillValue, DataTypeFillValueMetadataError>

Create a fill value from metadata for the inner data type.

Errors

Returns DataTypeFillValueMetadataError if the fill value is incompatible with the inner data type.

Trait Implementations

impl Clone for OptionalDataType

fn clone(&self) -> OptionalDataType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl DataTypeTraits for OptionalDataType

fn configuration(&self, version: ZarrVersion) -> Configuration

The configuration of the data type.

fn size(&self) -> DataTypeSize

The size of the data type.

fn fill_value( &self, fill_value_metadata: &FillValueMetadataV3, version: ZarrVersion, ) -> Result<FillValue, DataTypeFillValueMetadataError>

Create a fill value from metadata.

fn metadata_fill_value( &self, fill_value: &FillValue, ) -> Result<FillValueMetadataV3, DataTypeFillValueError>

Create fill value metadata.

fn as_any(&self) -> &(dyn Any + 'static)

Returns self as Any for downcasting.

fn configuration_v3(&self) -> Configuration

The Zarr V3 configuration of the data type.

fn configuration_v2(&self) -> Configuration

The Zarr V2 configuration of the data type.

fn fill_value_v2( &self, fill_value_metadata: &FillValueMetadataV3, ) -> Result<FillValue, DataTypeFillValueMetadataError>

Create a fill value from Zarr V2 metadata.

fn fill_value_v3( &self, fill_value_metadata: &FillValueMetadataV3, ) -> Result<FillValue, DataTypeFillValueMetadataError>

Create a fill value from Zarr V3 metadata.

fn eq(&self, other: &dyn DataTypeTraits) -> bool

Compare this data type with another for equality.

fn compatible_element_types(&self) -> &'static [TypeId]

Returns the set of Rust element types this data type is compatible with.

impl DataTypeTraitsV3 for OptionalDataType

fn create(metadata: &MetadataV3) -> Result<DataType, PluginCreateError>

Create a data type from Zarr V3 metadata.

impl Debug for OptionalDataType

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

Formats the value using the given formatter.

impl ExtensionAliases<ZarrVersion2> for OptionalDataType

fn aliases() -> RwLockReadGuard<'static, ExtensionAliasesConfig>

Get a read lock on the aliases configuration for this version.

fn aliases_mut() -> RwLockWriteGuard<'static, ExtensionAliasesConfig>

Get a write lock on the aliases configuration for this version.

fn matches_name(name: &str) -> bool

Check if the given name matches this extension’s identifier or any of its aliases for the given Zarr version.

impl ExtensionAliases<ZarrVersion3> for OptionalDataType

fn aliases() -> RwLockReadGuard<'static, ExtensionAliasesConfig>

Get a read lock on the aliases configuration for this version.

fn aliases_mut() -> RwLockWriteGuard<'static, ExtensionAliasesConfig>

Get a write lock on the aliases configuration for this version.

fn matches_name(name: &str) -> bool

Check if the given name matches this extension’s identifier or any of its aliases for the given Zarr version.

impl ExtensionNameStatic for OptionalDataType

const DEFAULT_NAME_FN: fn(ZarrVersion) -> Option<Cow<'static, str>>

Function pointer to get the default name for a given Zarr version.

impl PartialEq for OptionalDataType

fn eq(&self, other: &OptionalDataType) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for OptionalDataType