Skip to main content

Zstd

Struct Zstd 

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

zstd compression wrapper for outgoing and incoming links.

Only IO-based streams are supported; wrapping a packet-based stream fails.

Add this to a ConnectorBuilder and the AcceptorBuilder of the remote endpoint to compress all links of the connection.

Implementations§

Source§

impl Zstd

Source

pub const DEFAULT_LEVEL: i32 = 1

Default compression level.

This is the fastest regular level of zstd.

Source

pub fn new() -> Self

Creates a new zstd compression wrapper using the default level.

Source

pub fn with_level(level: i32) -> Self

Creates a new zstd compression wrapper using the specified compression level.

Higher levels compress better but are slower. Negative levels are faster than level 1 but compress worse. The level is clamped to the range supported by zstd.

Source

pub fn level(&self) -> i32

The compression level.

Source

pub fn set_window_log(&mut self, window_log: Option<u32>)

Sets the base 2 logarithm of the maximum window size.

This limits the memory used for compressing and decompressing each link. Received data that was compressed using a larger window cannot be decompressed, thus both ends must use the same setting.

If None (default), the window size is determined by the compression level for compressing and the default limit of zstd (128 MiB) applies to decompressing.

Trait Implementations§

Source§

impl AcceptingWrapper for Zstd

Source§

fn name(&self) -> &str

Name of the wrapper.
Source§

fn wrap<'life0, 'async_trait>( &'life0 self, stream: StreamBox, ) -> Pin<Box<dyn Future<Output = Result<StreamBox>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Wraps the incoming stream.
Source§

impl Clone for Zstd

Source§

fn clone(&self) -> Self

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 ConnectingWrapper for Zstd

Source§

fn name(&self) -> &str

Name of the wrapper.
Source§

fn wrap<'life0, 'async_trait>( &'life0 self, stream: StreamBox, ) -> Pin<Box<dyn Future<Output = Result<StreamBox>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Wraps the outgoing stream.
Source§

impl Debug for Zstd

Source§

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

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

impl Default for Zstd

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl Freeze for Zstd

§

impl RefUnwindSafe for Zstd

§

impl Send for Zstd

§

impl Sync for Zstd

§

impl Unpin for Zstd

§

impl UnsafeUnpin for Zstd

§

impl UnwindSafe for Zstd

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 #126799)
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> 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> MaybeSend for T
where T: Send + ?Sized,

Source§

impl<T> MaybeSync for T
where T: Sync + ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

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

fn try_from(value: U) -> Result<T, !>

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