Skip to content

BitInOutFormat

Oz edited this page Jan 20, 2023 · 16 revisions

The BitInOutFormat class specifies a format available for creating new archives and extract old ones. Usually, the user of the library should not create new formats and, instead, use the ones provided by the BitFormat namespace.

#include <bit7z/bitformat.hpp>

inherits from BitInFormat.

List of all members

Public Members

Return type Name
constexpr BitInOutFormat( unsigned char value, const tchar* ext, BitCompressionMethod defaultMethod, FormatFeatures features ) noexcept
const tchar * extension() const noexcept
FormatFeatures features() const noexcept
bool hasFeature( FormatFeatures feature ) const noexcept
BitCompressionMethod defaultMethod() const noexcept
unsigned char value() const noexcept
bool operator==( BitInFormat const& other ) const noexcept
bool operator!=( BitInFormat const& other ) const noexcept

Member Function Documentation

constexpr BitInOutFormat( unsigned char value, const tchar* ext, BitCompressionMethod defaultMethod, FormatFeatures features ) noexcept

Constructs a BitInOutFormat object with an ID value, an extension and a set of supported features.

Parameters:

  • value: the value of the format in the 7z SDK.
  • ext: the default file extension of the archive format.
  • defaultMethod: the default method used for compressing the archive format.
  • features: the set of features supported by the archive format

const tchar * extension() const noexcept

Returns the default file extension of the archive format.

FormatFeatures features() const noexcept

Returns the bitset of the features supported by the format.

bool hasFeature( FormatFeatures feature ) const noexcept

Checks if the format has a specific feature (see FormatFeatures enum).

Parameters:

  • feature: feature to be checked.

Returns a boolean value indicating whether the format has the given feature.

BitCompressionMethod defaultMethod() const noexcept

Returns the default method used for compressing the archive format.

unsigned char value() const noexcept

Returns the value of the format in the 7z SDK.

bool operator==( BitInFormat const& other ) const noexcept

Parameters:

  • other: the target object to compare to.

Returns a boolean value indicating whether this format is equal to the "other" or not.

bool operator!=( BitInFormat const& other ) const noexcept

Parameters:

  • other: the target object to compare to.

Returns a boolean value indicating whether this format is different from the "other" or not.

Clone this wiki locally