Compression backend vtable. More...

#include <compress.h>

Public Attributes
const char *	encoding_name

int(*	init )(void **state)
	Initialize compressor state.

int(*	compress )(void state, const char in, size_t in_len, char out, size_t out_len, int flush)
	Compress one chunk.

int(*	finish )(void state, char out, size_t *out_len)
	Finish compression and write any trailing bytes.

void(*	cleanup )(void *state)
	Clean up compressor state.

Detailed Description

Compression backend vtable.

Implementations provide init/compress/finish/cleanup lifecycle hooks. The middleware uses this interface so backends can be swapped or extended (e.g., Brotli, zstd) without changing middleware logic.

Definition at line 23 of file compress.h.

Member Data Documentation

◆ cleanup

void(* cwist_compress_backend::cleanup) (void *state)

Clean up compressor state.

Definition at line 52 of file compress.h.

◆ compress

int(* cwist_compress_backend::compress) (void *state, const char *in, size_t in_len, char *out, size_t *out_len, int flush)

Compress one chunk.

Parameters

state	Opaque state from init().
in	Input bytes.
in_len	Input length.
out	Output buffer.
out_len	In: capacity. Out: bytes written.
flush	Non-zero on final chunk.

Returns: 0 on success, -1 on error.

Definition at line 39 of file compress.h.

◆ encoding_name

const char* cwist_compress_backend::encoding_name

e.g. "gzip", "deflate"

Definition at line 24 of file compress.h.

◆ finish

int(* cwist_compress_backend::finish) (void *state, char *out, size_t *out_len)

Finish compression and write any trailing bytes.

Parameters

state	Opaque state from init().
out	Output buffer.
out_len	In: capacity. Out: bytes written.

Returns: 0 on success, -1 on error.

Definition at line 49 of file compress.h.

◆ init

int(* cwist_compress_backend::init) (void **state)

Initialize compressor state.

Definition at line 27 of file compress.h.

The documentation for this struct was generated from the following file:

include/cwist/sys/app/compress.h