Struct Bz3State 

pub struct Bz3State { /* private fields */ }

Wrapper for the raw Bz3State.

Implementations

impl Bz3State

pub fn new(block_size: usize) -> Result<Self>

Creates a new Bz3State.

pub const fn as_raw(&mut self) -> *mut bz3_state

pub fn error(&mut self) -> &'static str

pub fn encode_block( &mut self, buf: &mut [u8], input_size: usize, ) -> Result<usize>

Compresses a block in-place.

• input_size is the original data size before compression. It must not exceed the block size associated with the state.
• buf must be able to hold the data after compression. That’s, buf.len() >= bound(input_size) must be required, in some cases where the compressed data is larger than the original one.

Returns the size of data written to buf.

pub fn decode_block( &mut self, buf: &mut [u8], compressed_size: usize, original_size: usize, ) -> Result<()>

Decompresses a block in-place.

buf must be able to hold both compressed and original data.

The original doc states as below:

• buffer must be able to hold at least bz3_bound(orig_size) bytes
• in order to ensure decompression will succeed for all possible bzip3 blocks.
• In most (but not all) cases, orig_size should usually be sufficient.
• If it is not sufficient, you must allocate a buffer of size bz3_bound(orig_size) temporarily.
• If buffer_size is too small, BZ3_ERR_DATA_SIZE_TOO_SMALL will be returned.
• The size must not exceed the block size associated with the state.

Trait Implementations

impl Drop for Bz3State

fn drop(&mut self)

Executes the destructor for this type.

impl Send for Bz3State

impl Sync for Bz3State