Enum MaskMethod 

pub enum MaskMethod {
    Rle,
    Roaring,
    Blosc2 {
        codec: Blosc2Codec,
        level: i32,
    },
    Zstd {
        level: Option<i32>,
    },
    Lz4,
    None,
}

Bitmask compression method selector. Serialised in the CBOR descriptor’s masks[kind].method field; see plans/WIRE_FORMAT.md §6.5.1 for the schema.

Variants

Rle

Bit-level run-length encoding. See rle for on-wire layout.

Best on highly-clustered masks (land / sea, swath gaps). Worst on random alternating bits — the small-mask fallback at the encoder-integration layer redirects to MaskMethod::None in that case.

Roaring

Roaring Bitmap, serialised via the standard Roaring Portable Serialization Format.

Default mask method on every platform (including wasm32). Hybrid containers (array / bitmap / RLE) adapt to mask density automatically.

Blosc2

Blosc2 with BLOSC_BITSHUFFLE filter and a sub-codec (default LZ4). Feature-gated on blosc2.

Fields

codec: Blosc2Codec

Inner codec after the bit-shuffle.

level: i32

Codec-specific level (1..=9 for most).

Zstd

Zstandard on the bit-packed bytes.

Fields

level: Option<i32>

Optional level; None uses the codec’s default (3).

Lz4

LZ4 on the bit-packed bytes.

None

Uncompressed raw packed bytes — chosen automatically for tiny masks where compression overhead exceeds the savings.

Implementations

impl MaskMethod

pub fn name(&self) -> &'static str

Canonical string name used in the CBOR masks[kind].method field. Stable across the wire; do not change without a format version bump.

pub fn from_name(name: &str) -> Result<MaskMethod, MaskError>

Inverse of [name]. Does not parse the params sub-map — method-specific parameters are handled by the encoder / decoder integration layer. Returns MaskError::UnknownMethod if the name is not one of the known values. Returns a sub-codec feature-disabled error for blosc2 if the feature is off at build time.

Trait Implementations

impl Clone for MaskMethod

fn clone(&self) -> MaskMethod

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MaskMethod

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

Formats the value using the given formatter.

impl Default for MaskMethod

fn default() -> MaskMethod

Returns the “default value” for a type.

impl Eq for MaskMethod

impl PartialEq for MaskMethod

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MaskMethod