Squash  0.7.0
Data Fields
SquashStream Struct Reference

Compression/decompression streams. More...

Inheritance diagram for SquashStream:
_SquashObject

Data Fields

SquashObject base_object
 Base object.
 
SquashStreamPrivate * priv
 Private data. More...
 
const uint8_t * next_in
 The next input data to consume.
 
size_t avail_in
 Size (in bytes) of available input.
 
size_t total_in
 The total number of bytes input. More...
 
uint8_t * next_out
 The buffer to write output to.
 
size_t avail_out
 Number of bytes available in the output buffer.
 
size_t total_out
 Total number of bytes output. More...
 
SquashCodec * codec
 Codec used for this stream.
 
SquashOptions * options
 Options used for this stream.
 
SquashStreamType stream_type
 Stream type.
 
SquashStreamState state
 State the stream is in. More...
 
void * user_data
 User data. More...
 
SquashDestroyNotify destroy_user_data
 Squashlback to invoke on user_data when it is no longer necessary.
 
- Data Fields inherited from _SquashObject
volatile unsigned int ref_count
 The reference count.
 
volatile bool is_floating
 Whether or not the object has a floating reference.
 
SquashDestroyNotify destroy_notify
 Function to call when the reference count reaches 0.
 

Detailed Description

Compression/decompression streams.

Definition at line 58 of file stream.h.

Field Documentation

SquashStream::priv

Private data.

This is managed internally by Squash and should not be modified by consumers or plugins.

Definition at line 60 of file stream.h.

SquashStream::state

State the stream is in.

This is managed internally by Squash and should not be modified by consumers or plugins.

Definition at line 73 of file stream.h.

SquashStream::total_in

The total number of bytes input.

This is managed internally by Squash and should not be modified by consumers or plugins.

Definition at line 64 of file stream.h.

SquashStream::total_out

Total number of bytes output.

This is managed internally by Squash and should not be modified by consumers or plugins.

Definition at line 68 of file stream.h.

SquashStream::user_data

User data.

Note that this is for consumers of the library, not for plugins. It should be safe to use this from your application.

Definition at line 75 of file stream.h.


The documentation for this struct was generated from the following files: