Struct EncodeOptions

pub struct EncodeOptions<'a> { /* private fields */ }

Options that configure how data is compressed.

Examples

Supports builder like chaining.

use zeekstd::{EncodeOptions, FrameSizePolicy};

let raw_encoder = EncodeOptions::new()
    .checksum_flag(false)
    .compression_level(5)
    .frame_size_policy(FrameSizePolicy::Uncompressed(8192))
    .into_raw()?;

Implementations

impl<'a> EncodeOptions<'a>

pub fn new() -> Self

Creates a set of options with default initial values.

Panics

If allocation of CCtx fails.

pub fn try_new() -> Option<Self>

Tries to create new options with default initial values.

Returns None if allocation of CCtx fails.

pub fn with_cctx(cctx: CCtx<'a>) -> Self

Create options with the given compression context.

pub fn cctx(self, cctx: CCtx<'a>) -> Self

Sets a CCtx.

pub fn frame_size_policy(self, policy: FrameSizePolicy) -> Self

Sets a FrameSizePolicy.

pub fn checksum_flag(self, flag: bool) -> Self

Whether to write 32 bit checksums at the end of frames.

pub fn compression_level(self, level: CompressionLevel) -> Self

Sets the compression level used by zstd.

pub fn into_raw(self) -> Result<RawEncoder<'a>>

Creates a RawEncoder with the configuration.

Errors

Fails if the raw encoder cannot be created.

pub fn into_encoder<W>(self, writer: W) -> Result<Encoder<'a, W>>

Creates an Encoder with the configuration.

Errors

Fails if the encoder cannot be created.

Examples

use std::fs::File;
use zeekstd::EncodeOptions;

let output = File::create("data.zst").unwrap();
let raw = EncodeOptions::new()
    .checksum_flag(true)
    .into_encoder(output)
    .unwrap();

Trait Implementations

impl Default for EncodeOptions<'_>

fn default() -> Self

Returns the “default value” for a type.