bsa::doxygen_detail struct
#include <bsa/detail/common.hpp>

A doxygen only, detail class.

This is a class that exists solely to de-duplicate documentation. Do not attempt to use this.

Protected static functions

static void compress(): Compresses the file.
static auto compress_bound() -> std::size_t: Returns an upper bound on the storage size required to compress the file.
static auto compress_into(std::span<std::byte> a_out) -> std::size_t: Compresses the file into the given buffer.
static auto guess_file_format(std::filesystem::path a_path) -> std::optional<file_format>: Guesses the archive format for a given file.
static void read(): Reads the contents of the source.
static void write(): Writes the contents of the object to the destination.

Compresses the file.

Exceptions
bsa::compression_error	Thrown when any backend compression library errors are encountered.

Returns an upper bound on the storage size required to compress the file.

Exceptions
Returns	Returns the size required to successfully compress the file.
bsa::compression_error	Thrown when any backend compression library errors are encountered.

Compresses the file into the given buffer.

Parameters
a_out	The buffer to compress the file into.
Returns	The final size of the compressed buffer.
Exceptions
bsa::compression_error	Thrown when any backend compression library errors are encountered.

Guesses the archive format for a given file.

Exceptions
Returns	The guessed archive format for the given file, or `std::nullopt` if the file doesn't match any known format.
binary_io::buffer_exhausted	Thrown when reads index out of bounds.
bsa::exception	Thrown when parsing errors are encountered.

Reads the contents of the source.

Exceptions
binary_io::buffer_exhausted	Thrown when reads index out of bounds.

Writes the contents of the object to the destination.

Exceptions
std::system_error	Thrown when filesystem errors are encountered.
binary_io::buffer_exhausted	Thrown when the output buffer is exhausted.