Struct hdf5::Filters

pub struct Filters { /* fields omitted */ }

HDF5 filters and compression options.

Implementations

impl Filters

pub fn new() -> Self

pub fn gzip(&mut self, level: u8) -> &mut Self

Enable gzip compression with a specified level (0-9).

pub fn no_gzip(&mut self) -> &mut Self

Disable gzip compression.

pub fn get_gzip(&self) -> Option<u8>

Get the current settings for gzip filter.

pub fn szip(&mut self, nn: bool, level: u8) -> &mut Self

Enable szip compression with a specified method (EC, NN) and level (0-32).

If nn if set to true (default), the nearest neighbor method is used, otherwise the method is set to entropy coding.

pub fn no_szip(&mut self) -> &mut Self

Disable szip compression.

pub fn get_szip(&self) -> Option<(bool, u8)>

Get the current settings for szip filter.

Returns a tuple (nn, level), where nn indicates whether the nearest neighbor method is used and level is the associated compression level.

pub fn shuffle(&mut self, shuffle: bool) -> &mut Self

Enable or disable shuffle filter.

pub fn get_shuffle(&self) -> bool

Get the current settings for shuffle filter.

pub fn fletcher32(&mut self, fletcher32: bool) -> &mut Self

Enable or disable fletcher32 filter.

pub fn get_fletcher32(&self) -> bool

Get the current settings for fletcher32 filter.

pub fn scale_offset(&mut self, scale_offset: u32) -> &mut Self

Enable scale-offset filter with a specified factor (0 means automatic).

pub fn no_scale_offset(&mut self) -> &mut Self

Disable scale-offset compression.

pub fn get_scale_offset(&self) -> Option<u32>

Get the current settings for scale-offset filter.

pub fn gzip_default(&mut self) -> &mut Self

Enable gzip filter with default settings (compression level 4).

pub fn szip_default(&mut self) -> &mut Self

Enable szip filter with default settings (NN method, compression level 8).

pub fn has_filters(&self) -> bool

Returns true if any filters are enabled and thus chunkins is required.

pub fn validate(&self) -> Result<()>

Verify whether the filters configuration is valid.

Trait Implementations

impl Clone for Filters

fn clone(&self) -> Filters

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Filters

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

Formats the value using the given formatter.

impl Default for Filters

fn default() -> Self

Returns the "default value" for a type.

impl PartialEq<Filters> for Filters

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for Filters