Skip to main content

CompressionPolicy

Struct CompressionPolicy 

Source
pub struct CompressionPolicy { /* private fields */ }
Expand description

Policy controlling when compression is applied.

By default, messages below 1 KiB are not compressed — at that size, compression overhead (headers, Huffman tables, checksums) typically exceeds the space savings, and the CPU cost of initializing the compressor dominates.

§Example

use connectrpc::CompressionPolicy;

// Only compress messages >= 4 KiB
let policy = CompressionPolicy::default().min_size(4096);
assert!(!policy.should_compress(1024));
assert!(policy.should_compress(8192));

// Disable compression entirely
let policy = CompressionPolicy::disabled();
assert!(!policy.should_compress(1_000_000));

Implementations§

Source§

impl CompressionPolicy

Source

pub fn disabled() -> Self

Create a policy that disables compression entirely.

Source

pub fn min_size(self, size: usize) -> Self

Set the minimum message size for compression.

Messages smaller than this (in bytes, before compression) will be sent uncompressed even if compression is negotiated.

Source

pub fn should_compress(&self, message_size: usize) -> bool

Check whether compression should be applied for a message of the given size.

Zero-length bodies are compressed when min_size == 0 (useful for conformance testing where the runner checks that advertised encodings are used even for empty payloads). The Connect spec requires receivers to skip decompression for zero-length content, so this is safe.

Trait Implementations§

Source§

impl Clone for CompressionPolicy

Source§

fn clone(&self) -> CompressionPolicy

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for CompressionPolicy

Source§

impl Debug for CompressionPolicy

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CompressionPolicy

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more