.compression().constants().flush()
Access:
public

This is the flush contants class. It contains constants that can be used in the flush setting.

Summary

Name
Description
Returns the BLOCK constant.
Returns the FINISH constant.
Returns the FULL_FLUSH constant.
no
Returns the NO_FLUSH constant.
Returns the PARTIAL_FLUSH constant.
Returns the SYNC_FLUSH constant.
Returns the TREES constant.

Functions

.block()
Access:
public
Summary:
Returns the BLOCK constant.

This is the BLOCK constant. This means the compression class will flush every time a new block has been created. A block is a certain amount of data, which size depends on the machine you're using.

Returns

Type
Constant
Description
Z_BLOCK
.finish()
Access:
public
Summary:
Returns the FINISH constant.

This is the FINISH constant. This means the compression class will only do a flush when the compression has been ended.

Returns

Type
Constant
Description
Z_FINISH
.full()
Access:
public
Summary:
Returns the FULL_FLUSH constant.

This is the FULL_FLUSH constant. THis means the compression class will fully flush the stream every time new data has been added.

Returns

Type
Constant
Description
Z_FULL_FLUSH
.no()
Access:
public
Summary:
Returns the NO_FLUSH constant.

This is the NO_FLUSH constant. This means the compression class won't flush it's data when the flush setting is set to this.

Returns

Type
Constant
Description
Z_NO_FLUSH
.partial()
Access:
public
Summary:
Returns the PARTIAL_FLUSH constant.

This is the PARTIAL_FLUSH constant. This means the compression class will only do a partial flush when the flush setting is set to this.

Returns

Type
Constant
Description
Z_PARTIAL_FLUSH
.sync()
Access:
public
Summary:
Returns the SYNC_FLUSH constant.

This is the SYNC_FLUSH constant. This means the compression class will only flush if it needs to sync up when the flush setting is set to this. This happens when new data is added to the compression stream.

Returns

Type
Constant
Description
Z_SYNC_FLUSH
.trees()
Access:
public
Summary:
Returns the TREES constant.

This is the TREES constant. This means the compression class will only flush the tree. This is a sort of dictionary that is used to compress the data.

Returns

Type
Constant
Description
Z_TREES_FLUSH