Struct FillValueMessage 

pub struct FillValueMessage {
    pub alloc_time: u8,
    pub fill_write_time: u8,
    pub fill_defined: u8,
    pub fill_value: Option<Vec<u8>>,
}

Fill value message payload.

Fields

alloc_time: u8

Space allocation time: 1=early, 2=late, 3=incremental.

fill_write_time: u8

Fill value write time: 0=on alloc, 1=never, 2=if set.

fill_defined: u8

Fill value defined: 0=undefined, 1=default (zeros), 2=user-defined.

fill_value: Option<Vec<u8>>

User-defined fill value data. Present only when fill_defined == 2.

Implementations

impl FillValueMessage

pub fn with_value(data: Vec<u8>) -> Self

A user-defined fill value.

pub fn undefined() -> Self

An undefined fill value (no fill is performed).

pub fn encode(&self) -> Vec<u8>

Encode as a version-3 fill-value message (H5O__fill_new_encode).

pub fn encode_for(&self, format: ObjectFormat) -> Vec<u8>

Encode at the version a file of this format calls for (H5O__fill_new_encode, H5Ofill.c:409).

Version 2 spells out allocation time, write time and definedness as three bytes instead of packing them into flags, and — the part a version-3 reader must not assume — always writes the four-byte size field when the value is defined, even when the size is zero. That defined = 1, size = 0 shape is what libhdf5 writes for the default fill of a contiguous dataset in a classic file.

pub fn decode(buf: &[u8]) -> FormatResult<(Self, usize)>

Decode a fill-value message of version 1, 2, or 3.

Trait Implementations

impl Clone for FillValueMessage

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FillValueMessage

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

Formats the value using the given formatter.

impl Default for FillValueMessage

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for FillValueMessage

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FillValueMessage