SqshCompressionOptions Struct Reference

The compression options context is used to store the compression options for a specific compression algorithm. More...

#include <sqsh_archive_private.h>

Public Member Functions
SQSH_NO_UNUSED struct SqshCompressionOptions *	sqsh_compression_options_new (struct SqshArchive *sqsh, int *err)
	Initializes a SqshCompressionOptions struct.
uint32_t	sqsh_compression_options_gzip_compression_level (const struct SqshCompressionOptions *context)
	returns the compression level of gzip
uint16_t	sqsh_compression_options_gzip_window_size (const struct SqshCompressionOptions *context)
	returns the compression window size of gzip
enum SqshGzipStrategies	sqsh_compression_options_gzip_strategies (const struct SqshCompressionOptions *context)
	returns the compression strategy of gzip
uint32_t	sqsh_compression_options_xz_dictionary_size (const struct SqshCompressionOptions *context)
	returns the dictionary size of xz
enum SqshXzFilters	sqsh_compression_options_xz_filters (const struct SqshCompressionOptions *context)
	returns the compression options of xz
uint32_t	sqsh_compression_options_lz4_version (const struct SqshCompressionOptions *context)
	returns the version of lz4 used
uint32_t	sqsh_compression_options_lz4_flags (const struct SqshCompressionOptions *context)
	returns the flags of lz4
uint32_t	sqsh_compression_options_zstd_compression_level (const struct SqshCompressionOptions *context)
	returns the compression level of zstd
enum SqshLzoAlgorithm	sqsh_compression_options_lzo_algorithm (const struct SqshCompressionOptions *context)
	returns the algorithm of lzo
uint32_t	sqsh_compression_options_lzo_compression_level (const struct SqshCompressionOptions *context)
	returns the compression level of lzo
size_t	sqsh_compression_options_size (const struct SqshCompressionOptions *context)
	returns the size of the compression options struct
int	sqsh_compression_options_free (struct SqshCompressionOptions *context)
	Frees a SqshCompressionOptions struct.

Detailed Description

The compression options context is used to store the compression options for a specific compression algorithm.

Definition at line 189 of file sqsh_archive_private.h.

Member Function Documentation

sqsh_compression_options_free()

int sqsh_compression_options_free

(

struct SqshCompressionOptions *

context

)

Frees a SqshCompressionOptions struct.

Parameters

[in]

context

The file context to free.

Returns

0 on success, less than 0 on error

sqsh_compression_options_gzip_compression_level()

uint32_t sqsh_compression_options_gzip_compression_level

(

const struct SqshCompressionOptions *

context

)

returns the compression level of gzip

Parameters

[in]

context

the compression options context

Returns

the compression level of gzip

sqsh_compression_options_gzip_strategies()

enum SqshGzipStrategies sqsh_compression_options_gzip_strategies

(

const struct SqshCompressionOptions *

context

)

returns the compression strategy of gzip

Parameters

[in]

context

the compression options context

Returns

the compression strategy of gzip

sqsh_compression_options_gzip_window_size()

uint16_t sqsh_compression_options_gzip_window_size

(

const struct SqshCompressionOptions *

context

)

returns the compression window size of gzip

Parameters

[in]

context

the compression options context

Returns

the compression window size of gzip

sqsh_compression_options_lz4_flags()

uint32_t sqsh_compression_options_lz4_flags

(

const struct SqshCompressionOptions *

context

)

returns the flags of lz4

Parameters

[in]

context

the compression options context

Returns

the flags of lz4

sqsh_compression_options_lz4_version()

uint32_t sqsh_compression_options_lz4_version

(

const struct SqshCompressionOptions *

context

)

returns the version of lz4 used

Parameters

[in]

context

the compression options context

Returns

the version of lz4 used

sqsh_compression_options_lzo_algorithm()

enum SqshLzoAlgorithm sqsh_compression_options_lzo_algorithm

(

const struct SqshCompressionOptions *

context

)

returns the algorithm of lzo

Parameters

[in]

context

the compression options context

Returns

the algorithm of lzo

sqsh_compression_options_lzo_compression_level()

uint32_t sqsh_compression_options_lzo_compression_level

(

const struct SqshCompressionOptions *

context

)

returns the compression level of lzo

Parameters

[in]

context

the compression options context

Returns

the compression level of lzo

sqsh_compression_options_new()

SQSH_NO_UNUSED struct SqshCompressionOptions * sqsh_compression_options_new	(	struct SqshArchive *	sqsh,
		int *	err )

Initializes a SqshCompressionOptions struct.

Parameters

[in]	sqsh	Sqsh context
[out]	err	Pointer to an int where the error code will be stored.

Returns

The Initialized file context

sqsh_compression_options_size()

size_t sqsh_compression_options_size

(

const struct SqshCompressionOptions *

context

)

returns the size of the compression options struct

Parameters

[in]

context

the compression options context

Returns

the size of the compression options struct

sqsh_compression_options_xz_dictionary_size()

uint32_t sqsh_compression_options_xz_dictionary_size

(

const struct SqshCompressionOptions *

context

)

returns the dictionary size of xz

Parameters

[in]

context

the compression options context

Returns

the dictionary size of xz

sqsh_compression_options_xz_filters()

enum SqshXzFilters sqsh_compression_options_xz_filters

(

const struct SqshCompressionOptions *

context

)

returns the compression options of xz

Parameters

[in]

context

the compression options context

Returns

the compression options of xz

sqsh_compression_options_zstd_compression_level()

uint32_t sqsh_compression_options_zstd_compression_level

(

const struct SqshCompressionOptions *

context

)

returns the compression level of zstd

Parameters

[in]

context

the compression options context

Returns

the compression level of zstd

---

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

• libsqsh/include/sqsh_archive_private.h
• include/sqsh_archive.h