Struct CompressionRegistry 

pub struct CompressionRegistry { /* private fields */ }

Registry of compression providers.

The registry maps encoding names to their provider implementations. Use CompressionRegistry::default() to get a registry with all feature-enabled built-in providers.

Implementations

impl CompressionRegistry

pub fn new() -> Self

Create an empty compression registry.

Use register to add providers, or use default to get a registry with built-in providers.

pub fn register<P: CompressionProvider>(self, provider: P) -> Self

Register a compression provider.

Returns self for method chaining.

Example

use connectrpc::compression::{CompressionRegistry, GzipProvider, ZstdProvider};
let registry = CompressionRegistry::new()
    .register(GzipProvider::default())
    .register(ZstdProvider::default());
assert!(registry.supports("gzip"));
assert!(registry.supports("zstd"));

pub fn get(&self, name: &str) -> Option<Arc<dyn CompressionProvider>>

Get a provider by encoding name.

Returns None if no provider is registered for the given name.

pub fn supports(&self, name: &str) -> bool

Check if a provider is registered for the given encoding name.

pub fn supported_encodings(&self) -> Vec<&'static str>

List all supported encoding names.

pub fn accept_encoding_header(&self) -> &str

Get a comma-separated string of supported encodings.

Useful for Accept-Encoding headers. The string is computed once when providers are registered and cached, so this is a cheap lookup.

pub fn negotiate_encoding( &self, accept_encoding: Option<&str>, request_encoding: Option<&str>, ) -> Option<&'static str>

Negotiate a response encoding based on the client’s accept-encoding header.

Returns the first encoding from the client’s preference list that this registry supports, or None if only identity is acceptable.

Per the Connect spec, the accept-encoding header is treated as an ordered list with most preferred first (no quality values).

If the client omits accept-encoding, the spec says the server may assume the client accepts the same encoding used for the request (if any), plus identity.

pub fn decompress_with_limit( &self, encoding: &str, data: Bytes, max_size: usize, ) -> Result<Bytes, ConnectError>

Decompress data using the specified encoding with a size limit.

Returns an error if the encoding is not supported or if the decompressed data exceeds max_size. This protects against compression bomb attacks.

For identity encoding, returns the data without copying.

pub fn compress( &self, encoding: &str, data: &[u8], ) -> Result<Bytes, ConnectError>

Compress data using the specified encoding.

Returns an error if the encoding is not supported.

pub fn register_streaming<P: StreamingCompressionProvider>( self, provider: P, ) -> Self

Available on crate feature streaming only.

Register a streaming compression provider.

This also registers the provider for buffered compression. Returns self for method chaining.

Available when the streaming feature is enabled.

pub fn get_streaming( &self, name: &str, ) -> Option<Arc<dyn StreamingCompressionProvider>>

Available on crate feature streaming only.

Get a streaming provider by encoding name.

Returns None if no streaming provider is registered for the given name.

pub fn supports_streaming(&self, name: &str) -> bool

Available on crate feature streaming only.

Check if streaming compression is supported for the given encoding name.

pub fn decompress_stream( &self, encoding: &str, reader: BoxedAsyncBufRead, ) -> Result<BoxedAsyncRead, ConnectError>

Available on crate feature streaming only.

Create a streaming decompressor for the specified encoding.

Returns an AsyncRead that decompresses data from the input reader. Returns an error if the encoding is not supported for streaming.

pub fn compress_stream( &self, encoding: &str, reader: BoxedAsyncBufRead, ) -> Result<BoxedAsyncRead, ConnectError>

Available on crate feature streaming only.

Create a streaming compressor for the specified encoding.

Returns an AsyncRead that compresses data from the input reader. Returns an error if the encoding is not supported for streaming.

Trait Implementations

impl Clone for CompressionRegistry

fn clone(&self) -> CompressionRegistry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompressionRegistry

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

Formats the value using the given formatter.

impl Default for CompressionRegistry

fn default() -> Self

Create a registry with all feature-enabled built-in providers.