Struct z_stream

#[repr(C)]
pub struct z_stream {

    pub next_in: *const u8,
    pub avail_in: u32,
    pub total_in: u64,
    pub next_out: *mut u8,
    pub avail_out: u32,
    pub total_out: u64,
    pub msg: *mut i8,
    pub state: *mut internal_state,
    pub zalloc: Option<unsafe extern "C" fn(_: *mut c_void, _: u32, _: u32) -> *mut c_void>,
    pub zfree: Option<unsafe extern "C" fn(_: *mut c_void, _: *mut c_void)>,
    pub opaque: *mut c_void,
    pub data_type: i32,
    pub adler: u64,
    pub reserved: u64,
}

The current stream state

Custom allocators

The low-level API supports passing in a custom allocator as part of the z_stream:

struct z_stream {
    // ...
    zalloc: Option<unsafe extern "C" fn(*mut c_void, c_uint, c_uint) -> *mut c_void>,
    zfree: Option<unsafe extern "C" fn(*mut c_void, *mut c_void)>,
    opaque: *mut c_void,
}

When these fields are None (or NULL in C), the initialization functions use a default allocator, based on feature flags:

• "rust-allocator" uses the rust global allocator
• "c-allocator" uses an allocator based on malloc and free

When both are configured, the "rust-allocator" is preferred. When no default allocator is configured, and custom zalloc and zfree are provided, the initialization functions will return a Z_STREAM_ERROR.

When custom zalloc and zfree functions are given, they must adhere to the following contract to be safe:

• a call zalloc(opaque, n, m) must return a pointer p to n * m bytes of memory, or NULL if out of memory
• a call zfree(opaque, p) must free that memory

The strm.opaque value is passed to as the first argument to all calls to zalloc and zfree, but is otherwise ignored by the library.

Fields

next_in: *const u8

avail_in: u32

total_in: u64

next_out: *mut u8

avail_out: u32

total_out: u64

msg: *mut i8

state: *mut internal_state

zalloc: Option<unsafe extern "C" fn(_: *mut c_void, _: u32, _: u32) -> *mut c_void>

zfree: Option<unsafe extern "C" fn(_: *mut c_void, _: *mut c_void)>

opaque: *mut c_void

data_type: i32

adler: u64

reserved: u64

Implementations

impl z_stream

pub fn configure_default_rust_allocator(&mut self)

Trait Implementations

impl Clone for z_stream

fn clone(&self) -> z_stream

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for z_stream

fn default() -> z_stream

Returns the “default value” for a type.

impl Copy for z_stream