Struct DecompressionConfig 

pub struct DecompressionConfig {
    pub algorithm: DecompressionAlgorithm,
    pub dictionary_path: Option<PathBuf>,
}

Configuration for decompressing message payloads.

This applies to compression performed by the producer on each message payload, before the payload was sent. Transport-level compression is handled by the protocol layer and does not require this option.

Payloads are decompressed before framing and decoding are applied.

Fields

algorithm: DecompressionAlgorithm

The decompression algorithm.

dictionary_path: Option<PathBuf>

The path to a compression dictionary to use when decompressing payloads.

The dictionary must be the same as the one used by the producer when compressing the payloads. Only supported with the zstd algorithm.

Implementations

impl DecompressionConfig

pub fn build(&self) -> Result<Decompressor>

Builds a Decompressor from this configuration.

The dictionary, if configured, is read and prepared once here so that per-payload decompression can reference it cheaply.

Errors

Returns an error if a dictionary is configured with a non-zstd algorithm, or if the dictionary file cannot be read.

Trait Implementations

impl Clone for DecompressionConfig

fn clone(&self) -> DecompressionConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Configurable for DecompressionConfig

fn referenceable_name() -> Option<&'static str>

Gets the referenceable name of this value, if any.

fn metadata() -> Metadata

Gets the metadata for this value.

fn generate_schema( schema_gen: &RefCell<SchemaGenerator>, ) -> Result<SchemaObject, GenerateError>

Generates the schema for this value.

fn is_optional() -> bool

where Self: Sized,

Whether or not this value is optional.

fn validate_metadata(_metadata: &Metadata) -> Result<(), GenerateError>

where Self: Sized,

Validates the given metadata against this type.

fn as_configurable_ref() -> ConfigurableRef

where Self: Sized + 'static,

Create a new configurable reference table.

impl Debug for DecompressionConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DecompressionConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DecompressionConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToValue for DecompressionConfig

fn to_value(&self) -> Value

Convert this value into a serde_json::Value. Must not fail.