Struct zstd_safe::CCtx

source ·
pub struct CCtx<'a>(/* private fields */);

Implementations§

source§

impl CCtx<'static>

source

pub fn try_create() -> Option<Self>

Tries to create a new context.

Returns None if zstd returns a NULL pointer - may happen if allocation fails.

source

pub fn create() -> Self

Wrap ZSTD_createCCtx

§Panics

If zstd returns a NULL pointer.

source§

impl<'a> CCtx<'a>

source

pub fn compress<C: WriteBuf + ?Sized>( &mut self, dst: &mut C, src: &[u8], compression_level: CompressionLevel ) -> SafeResult

Wraps the ZSTD_compressCCtx() function

source

pub fn compress2<C: WriteBuf + ?Sized>( &mut self, dst: &mut C, src: &[u8] ) -> SafeResult

Wraps the ZSTD_compress2() function.

source

pub fn compress_using_dict<C: WriteBuf + ?Sized>( &mut self, dst: &mut C, src: &[u8], dict: &[u8], compression_level: CompressionLevel ) -> SafeResult

Wraps the ZSTD_compress_usingDict() function.

source

pub fn compress_using_cdict<C: WriteBuf + ?Sized>( &mut self, dst: &mut C, src: &[u8], cdict: &CDict<'_> ) -> SafeResult

Wraps the ZSTD_compress_usingCDict() function.

source

pub fn init(&mut self, compression_level: CompressionLevel) -> usize

source

pub fn load_dictionary(&mut self, dict: &[u8]) -> SafeResult

source

pub fn ref_cdict<'b>(&mut self, cdict: &CDict<'b>) -> SafeResult
where 'b: 'a,

Wraps the ZSTD_CCtx_refCDict() function.

Dictionary must outlive the context.

source

pub fn ref_prefix<'b>(&mut self, prefix: &'b [u8]) -> SafeResult
where 'b: 'a,

source

pub fn compress_stream<C: WriteBuf + ?Sized>( &mut self, output: &mut OutBuffer<'_, C>, input: &mut InBuffer<'_> ) -> SafeResult

source

pub fn compress_stream2<C: WriteBuf + ?Sized>( &mut self, output: &mut OutBuffer<'_, C>, input: &mut InBuffer<'_>, end_op: ZSTD_EndDirective ) -> SafeResult

Wraps the ZSTD_compressStream2() function.

source

pub fn flush_stream<C: WriteBuf + ?Sized>( &mut self, output: &mut OutBuffer<'_, C> ) -> SafeResult

Wraps the ZSTD_flushStream() function.

source

pub fn end_stream<C: WriteBuf + ?Sized>( &mut self, output: &mut OutBuffer<'_, C> ) -> SafeResult

Wraps the ZSTD_endStream() function.

source

pub fn sizeof(&self) -> usize

source

pub fn reset(&mut self, reset: ResetDirective) -> SafeResult

source

pub fn set_parameter(&mut self, param: CParameter) -> SafeResult

source

pub fn set_pledged_src_size(&mut self, pledged_src_size: u64) -> SafeResult

source

pub fn in_size() -> usize

source

pub fn out_size() -> usize

Trait Implementations§

source§

impl Default for CCtx<'_>

source§

fn default() -> Self

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

impl<'a> Drop for CCtx<'a>

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl<'a> Send for CCtx<'a>

Auto Trait Implementations§

§

impl<'a> RefUnwindSafe for CCtx<'a>

§

impl<'a> !Sync for CCtx<'a>

§

impl<'a> Unpin for CCtx<'a>

§

impl<'a> UnwindSafe for CCtx<'a>

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> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

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, U> TryFrom<U> for T
where U: Into<T>,

§

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>,

§

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.