Struct Filter 

#[non_exhaustive]
pub struct Filter {
    pub id: u16,
    pub name: Option<String>,
    pub is_optional: bool,
    pub client_data: Vec<u32>,
}

One filter in a dataset’s pipeline.

The curated per-filter analogue of H5Pget_filter2. Obtain the ordered pipeline with Dataset::filter_pipeline; Dataset::filters stays the lighter call when only the identifiers are needed.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: u16

The registered HDF5 filter identifier, the same numbering returned by Dataset::filters. Display names the ones this crate knows, such as 1 = deflate or 32000 = lzf.

name: Option<String>

The filter’s recorded name, when the file stores one. Absent for most built-in filters, which are identified by id alone.

is_optional: bool

Whether the filter is optional. When true, a reader that cannot apply the filter may skip it; a mandatory filter (false) must be applied for the data to decode correctly.

client_data: Vec<u32>

The filter’s client data (cd_values): the auxiliary parameters stored with it — for deflate, one value, the compression level. The meaning is filter-specific.

Trait Implementations

impl Clone for Filter

fn clone(&self) -> Filter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Filter

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

Formats the value using the given formatter.

impl Display for Filter

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

The filter’s name and its client data, as deflate(6). A filter this crate does not name carries its identifier in the same parentheses — custom(id=40000) — so the parentheses hold the filter’s parameters and nothing else.

impl Eq for Filter

impl PartialEq for Filter

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Filter