BmnCompressionGlobalFunctions.h File Reference

#include "BmnFileProcessingFlags.h"
#include "BmnIFileReader.h"
#include <filesystem>
#include <string_view>

Include dependency graph for BmnCompressionGlobalFunctions.h:

Go to the source code of this file.

Macros
#define	BmnCompressionGlobalFunctions_h

Functions
bool	BmnCompressionIsArchiveLibAvailable (const BmnFileType aLibraryType) noexcept
BmnIFileReader *	BmnCompressionCreateNewSuitableReaderForAFile (const std::filesystem::path &aFilePath, const BmnFileType aPreferredTypeForThisAlgorithm=BmnFileType::Unknown)
BmnIFileReader *	BmnCompressionCreateNewSuitableReaderForAFile (std::filesystem::path &&aFilePath, const BmnFileType aPreferredTypeForThisAlgorithm=BmnFileType::Unknown)
std::filesystem::path	BmnCompressionRemoveArchiveExtension (std::filesystem::path aFilePath)

Variables
constexpr std::string_view	BmnCompressionArchiveExtensions [] {".zst", ".zstd", ".gz", ".gzip", ".xz", ".lzma"}

Macro Definition Documentation

BmnCompressionGlobalFunctions_h

#define BmnCompressionGlobalFunctions_h

Definition at line 3 of file BmnCompressionGlobalFunctions.h.

Function Documentation

BmnCompressionCreateNewSuitableReaderForAFile() [1/2]

BmnIFileReader * BmnCompressionCreateNewSuitableReaderForAFile ( const std::filesystem::path & aFilePath, const BmnFileType aPreferredTypeForThisAlgorithm = BmnFileType::Unknown )

nodiscard

Definition at line 75 of file BmnCompressionGlobalFunctions.cxx.

BmnCompressionCreateNewSuitableReaderForAFile() [2/2]

BmnIFileReader * BmnCompressionCreateNewSuitableReaderForAFile ( std::filesystem::path && aFilePath, const BmnFileType aPreferredTypeForThisAlgorithm = BmnFileType::Unknown )

nodiscard

Definition at line 104 of file BmnCompressionGlobalFunctions.cxx.

BmnCompressionIsArchiveLibAvailable()

bool BmnCompressionIsArchiveLibAvailable ( const BmnFileType aLibraryType )

nodiscardnoexcept

Definition at line 40 of file BmnCompressionGlobalFunctions.cxx.

BmnCompressionRemoveArchiveExtension()

std::filesystem::path BmnCompressionRemoveArchiveExtension ( std::filesystem::path aFilePath )

nodiscard

Definition at line 133 of file BmnCompressionGlobalFunctions.cxx.

Variable Documentation

BmnCompressionArchiveExtensions

std::string_view BmnCompressionArchiveExtensions[] {".zst", ".zstd", ".gz", ".gzip", ".xz", ".lzma"}

inlineconstexpr

Definition at line 16 of file BmnCompressionGlobalFunctions.h.