bsa::compression_error class
#include <bsa/detail/common.hpp>

Classifies errors generated during compression library operations.

Base classes

class exception
The base exception type for all bsa exceptions.

Public types

enum class library { internal, zlib, lz4, xmem }
A list of back end libraries used for compression.

Public functions

auto what(T... args) -> T

Observers

auto source_library() const -> library noexcept
Returns the library which was the origin of this error.
auto what() const -> const char* override noexcept
Obtains the explanation for why the exception was thrown.

Enum documentation

enum class bsa::compression_error::library

A list of back end libraries used for compression.

Enumerators
internal

An internal error.

Likely caused by some failure to validate an invariant, or a failure to open a compression library.
zlib

zlib - A massively spiffy yet delicately unobtrusive compression library.
lz4

LZ4 - Extremely Fast Compression algorithm.
xmem

XMem codec - xcompress from the Xbox SDK.