libaegis/compres_algo.h File Reference

Go to the source code of this file.

Enumerations
enum	compression_algorithm_t {   compression_algorithm_not_set, compression_algorithm_none, compression_algorithm_gzip, compression_algorithm_bzip2,   compression_algorithm_unspecified }
Functions
compression_algorithm_t	compression_algorithm_by_name (const char *name)
const char *	compression_algorithm_name (compression_algorithm_t x)
const char *	compression_algorithm_extension (compression_algorithm_t x)

---

Enumeration Type Documentation

enum compression_algorithm_t

Enumerator:

compression_algorithm_not_set
compression_algorithm_none
compression_algorithm_gzip
compression_algorithm_bzip2
compression_algorithm_unspecified

Definition at line 24 of file compres_algo.h.

---

Function Documentation

compression_algorithm_t compression_algorithm_by_name

(

const char *

name

)

The compression_algorithm_by_name function is used to turn an algorithm name into an algorithm enum value. Typically this is used to translate command line options.

Parameters:

name

The string to translate.

Returns:

algorithm enum value

const char* compression_algorithm_extension

(

compression_algorithm_t

x

)

The compression_algorithm_extension function is used to obtain the file name extension corresponding to the given compression algorithm.

Parameters:

x

The value to be translated.

Returns:

pointer to C string. DO NOT free or delete.

const char* compression_algorithm_name

(

compression_algorithm_t

x

)

The compression_algorithm_name function is used to translate a compression algorithm enum value into the equivalent string. This is typically used in error messages and trace output.

Parameters:

x

The value to be translated.

Returns:

pointer to C string. DO NOT free or delete.