Struct zstd_safe::DCtx

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

A Decompression Context.

The lifetime references the potential dictionary used for this context.

If no dictionary was used, it will most likely be 'static.

Same as DStream.

Implementations

impl DCtx<'static>

pub fn try_create() -> Option<Self>

pub fn create() -> Self

impl<'a> DCtx<'a>

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

Wraps the ZSTD_decompressDCtx() function.

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

Wraps ZSTD_decompress_usingDict

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

Wraps the ZSTD_decompress_usingDDict() function.

pub fn init(&mut self) -> usize

Wraps the ZSTD_initCStream() function.

Initializes an existing DStream for decompression.

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

👎 Deprecated

This is supported on crate feature experimental only.

Wraps the ZSTD_initDStream_usingDict() function.

pub fn init_using_ddict<'b>(&mut self, ddict: &DDict<'b>) -> SafeResult where
    'b: 'a, 

👎 Deprecated

This is supported on crate feature experimental only.

Wraps the ZSTD_initDStream_usingDDict() function.

pub fn reset(&mut self) -> SafeResult

Wraps the ZSTD_resetDStream() function.

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

pub fn ref_ddict<'b>(&mut self, ddict: &DDict<'b>) -> SafeResult where
    'b: 'a, 

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

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

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

Wraps the ZSTD_decompressStream() function.

pub fn in_size() -> usize

Wraps the ZSTD_DStreamInSize() function.

Returns a hint for the recommended size of the input buffer for decompression.

pub fn out_size() -> usize

Wraps the ZSTD_DStreamOutSize() function.

Returns a hint for the recommended size of the output buffer for decompression.

pub fn sizeof(&self) -> usize

Wraps the ZSTD_sizeof_DCtx() function.

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

This is supported on crate feature experimental only.

Wraps the ZSTD_decompressBlock() function.

pub fn insert_block(&mut self, block: &[u8]) -> usize

This is supported on crate feature experimental only.

Wraps the ZSTD_insertBlock() function.

pub fn try_clone(&self) -> Result<Self, ErrorCode>

This is supported on crate feature experimental only.

Creates a copy of this context.

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

Trait Implementations

impl Default for DCtx<'_>

fn default() -> Self

Returns the “default value” for a type.

impl Drop for DCtx<'_>

fn drop(&mut self)

Executes the destructor for this type.

impl Send for DCtx<'_>