Struct zarrs::array::codec::array_to_bytes::pcodec::PcodecCodecConfigurationV1

pub struct PcodecCodecConfigurationV1 {
    pub level: PcodecCompressionLevel,
    pub delta_encoding_order: Option<PcodecDeltaEncodingOrder>,
    pub int_mult_spec: bool,
    pub float_mult_spec: bool,
    pub max_page_n: usize,
}

Available on crate feature pcodec only.

Configuration parameters for the pcodec codec (version 1.0 draft).

Based upon pco::ChunkConfig.

Example: encode with a compression level of 12 and otherwise default parameters

{
    "level": 12
}

Fields

level: PcodecCompressionLevel

A compression level from 0-12, where 12 takes the longest and compresses the most.

The default is 8.

delta_encoding_order: Option<PcodecDeltaEncodingOrder>

Either a delta encoding level from 0-7 or None.

If set to None, pcodec will try to infer the optimal delta encoding order. The default is None.

int_mult_spec: bool

If enabled, pcodec will consider using int mult mode, which can substantially improve compression ratio but decrease speed in some cases for integer types.

The default is true.

float_mult_spec: bool

If enabled, pcodec will consider using float mult mode, which can substantially improve compression ratio but decrease speed in some cases for float types.

The default is true.

max_page_n: usize

The maximum number of values to encode per pcodec page.

If set too high or too low, pcodec’s compression ratio may drop. See https://docs.rs/pco/latest/pco/enum.PagingSpec.html#variant.EqualPagesUpTo.

The default is 1 << 18.

Trait Implementations

impl Clone for PcodecCodecConfigurationV1

fn clone(&self) -> PcodecCodecConfigurationV1

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PcodecCodecConfigurationV1

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

Formats the value using the given formatter.

impl Default for PcodecCodecConfigurationV1

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PcodecCodecConfigurationV1

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PcodecCodecConfigurationV1

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

Formats the value using the given formatter.

impl From<PcodecCodecConfigurationV1> for PcodecCodecConfiguration

fn from(original: PcodecCodecConfigurationV1) -> PcodecCodecConfiguration

Converts to this type from the input type.

impl PartialEq for PcodecCodecConfigurationV1

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PcodecCodecConfigurationV1

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for PcodecCodecConfigurationV1

impl Eq for PcodecCodecConfigurationV1

impl StructuralPartialEq for PcodecCodecConfigurationV1