Struct CParams

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

Wrapper to blosc2_cparams.
Compression parameters.

A normal way to construct this is using std::convert::From<&T>(val) so it will create with default parameters and the correct typesize.

Example

use blosc2::CParams;
let values = vec![0u8, 1, 2, 3];
let cparams = CParams::new::<u8>()
    .set_nthreads(2);  // Optionally adjust default values

Implementations

impl CParams

pub fn new<T>() -> Self

pub fn from_typesize(typesize: usize) -> Self

pub fn set_codec(self, codec: Codec) -> Self

Set codec, defaults to Codec::BloscLz

pub fn set_clevel(self, clevel: CLevel) -> Self

Set clevel, defaults to CLevel::Nine

pub fn set_filter(self, filter: Filter) -> Self

Set filter, defaults to Filter::Shuffle

pub fn set_nthreads(self, n: usize) -> Self

Set number of threads, defaults to 1

pub fn get_nthreads(&self) -> usize

Get number of threads

pub fn set_typesize<T>(self) -> Self

Set the type size

pub fn get_typesize(&self) -> usize

Trait Implementations

impl Default for CParams

fn default() -> Self

Returns the “default value” for a type.

impl<T> From<&T> for CParams

Create CParams from a reference to the type being compressed

fn from(_: &T) -> Self

Converts to this type from the input type.

impl From<CParams> for Context

fn from(cparams: CParams) -> Self

Converts to this type from the input type.