Struct FillValue 

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

A fill value.

Provides an element value to use for uninitialised portions of the Zarr array.

For optional data types, the fill value includes an extra trailing byte:

• 0x00 suffix indicates null/missing
• 0x01 suffix indicates non-null (inner bytes precede the suffix)

For nested optional types, each nesting level adds its own suffix byte.

Implementations

impl FillValue

pub fn new(bytes: Vec<u8>) -> Self

Create a new fill value composed of bytes.

pub fn new_optional_null() -> Self

Create a null optional fill value.

Returns a fill value with a single 0x00 byte indicating null. Can be chained with into_optional to create nested optional fill values.

Examples

// Null fill value for Option<T>
let null_fill = FillValue::new_optional_null();
assert_eq!(null_fill.as_ne_bytes(), &[0]);

// Some(None) fill value for Option<Option<T>>
let some_null = FillValue::new_optional_null().into_optional();
assert_eq!(some_null.as_ne_bytes(), &[0, 1]);

pub fn size(&self) -> usize

Returns the size in bytes of the fill value.

pub fn as_ne_bytes(&self) -> &[u8]

Return the byte representation of the fill value.

pub fn equals_all(&self, bytes: &[u8]) -> bool

Check if the bytes are equal to a sequence of the fill value.

pub fn into_optional(self) -> Self

Wrap this fill value as a non-null optional fill value.

Appends a 0x01 suffix byte indicating the value is non-null. Can be chained to create nested optional fill values.

Examples

// Single level optional (Some(u8))
let opt_fill = FillValue::from(42u8).into_optional();
assert_eq!(opt_fill.as_ne_bytes(), &[42, 1]);

// Double level optional (Some(Some(u8)))
let nested = FillValue::from(42u8).into_optional().into_optional();
assert_eq!(nested.as_ne_bytes(), &[42, 1, 1]);

Trait Implementations

impl Clone for FillValue

fn clone(&self) -> FillValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FillValue

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

Formats the value using the given formatter.

impl Display for FillValue

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

Formats the value using the given formatter.

impl From<&[u8]> for FillValue

fn from(value: &[u8]) -> Self

Converts to this type from the input type.

impl<const N: usize> From<&[u8; N]> for FillValue

fn from(value: &[u8; N]) -> Self

Converts to this type from the input type.

impl From<&str> for FillValue

fn from(value: &str) -> Self

Converts to this type from the input type.

impl<const N: usize> From<[u8; N]> for FillValue

fn from(value: [u8; N]) -> Self

Converts to this type from the input type.

impl From<()> for FillValue

fn from((): ()) -> Self

Converts to this type from the input type.

impl<T> From<Complex<T>> for FillValue

where FillValue: From<T>,

fn from(value: Complex<T>) -> Self

Converts to this type from the input type.

impl<T> From<Option<T>> for FillValue

where FillValue: From<T>,

fn from(value: Option<T>) -> Self

Converts to this type from the input type.

impl From<String> for FillValue

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for FillValue

fn from(value: Vec<u8>) -> Self

Converts to this type from the input type.

impl From<bf16> for FillValue

fn from(value: bf16) -> Self

Converts to this type from the input type.

impl From<bool> for FillValue

fn from(value: bool) -> Self

Converts to this type from the input type.

impl From<f16> for FillValue

fn from(value: f16) -> Self

Converts to this type from the input type.

impl From<f32> for FillValue

fn from(value: f32) -> Self

Converts to this type from the input type.

impl From<f64> for FillValue

fn from(value: f64) -> Self

Converts to this type from the input type.

impl From<i16> for FillValue

fn from(value: i16) -> Self

Converts to this type from the input type.

impl From<i32> for FillValue

fn from(value: i32) -> Self

Converts to this type from the input type.

impl From<i64> for FillValue

fn from(value: i64) -> Self

Converts to this type from the input type.

impl From<i8> for FillValue

fn from(value: i8) -> Self

Converts to this type from the input type.

impl From<u16> for FillValue

fn from(value: u16) -> Self

Converts to this type from the input type.

impl From<u32> for FillValue

fn from(value: u32) -> Self

Converts to this type from the input type.

impl From<u64> for FillValue

fn from(value: u64) -> Self

Converts to this type from the input type.

impl From<u8> for FillValue

fn from(value: u8) -> Self

Converts to this type from the input type.

impl PartialEq for FillValue

fn eq(&self, other: &FillValue) -> 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 FillValue

impl StructuralPartialEq for FillValue