Struct zstd_safe::CCtx

pub struct CCtx<'a>(_, _);

Implementations

impl CCtx<'static>

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.

pub fn create() -> Self

Wrap ZSTD_createCCtx

Panics

If zstd returns a NULL pointer.

impl<'a> CCtx<'a>

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

Wraps the ZSTD_compressCCtx() function

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

Wraps the ZSTD_compress2() function.

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.

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

Wraps the ZSTD_compress_usingCDict() function.

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

pub fn init_src_size(
    &mut self,
    compression_level: CompressionLevel,
    pledged_src_size: u64
) -> usize

👎 Deprecated

Available on crate feature experimental only.

Wraps the ZSTD_initCStream_srcSize() function.

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

👎 Deprecated

Available on crate feature experimental only.

Wraps the ZSTD_initCStream_usingDict() function.

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

👎 Deprecated

Available on crate feature experimental only.

Wraps the ZSTD_initCStream_usingCDict() function.

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

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.

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

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

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.

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

Wraps the ZSTD_flushStream() function.

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

Wraps the ZSTD_endStream() function.

pub fn sizeof(&self) -> usize

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

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

👎 Deprecated

Available on crate feature experimental only.

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

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

pub fn try_clone(
    &self,
    pledged_src_size: Option<u64>
) -> Result<Self, ErrorCode>

Available on crate feature experimental only.

Creates a copy of this context.

This only works before any data has been compressed. An error will be returned otherwise.

pub fn get_block_size(&self) -> usize

Available on crate feature experimental only.

Wraps the ZSTD_getBlockSize() function.

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

Available on crate feature experimental only.

Wraps the ZSTD_compressBlock() function.

pub fn in_size() -> usize

pub fn out_size() -> usize

Trait Implementations

impl Default for CCtx<'_>

fn default() -> Self

Returns the “default value” for a type.

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

fn drop(&mut self)

Executes the destructor for this type.

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