BitInOutFormat Class Reference

The BitInOutFormat class specifies a format available for creating new archives and extract old ones. More...

#include <bit7z/bitformat.hpp>

Inheritance diagram for BitInOutFormat:

Collaboration diagram for BitInOutFormat:

Public Member Functions
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.
auto	defaultMethod () const noexcept -> BitCompressionMethod
auto	extension () const noexcept -> const tchar *
auto	features () const noexcept -> FormatFeatures
auto	hasFeature (FormatFeatures feature) const noexcept -> bool
	Checks if the format has a specific feature (see FormatFeatures enum).
auto	operator!= (BitInFormat const &other) const noexcept -> bool
auto	operator== (BitInFormat const &other) const noexcept -> bool
auto	value () const noexcept -> unsigned char

Detailed Description

The BitInOutFormat class specifies a format available for creating new archives and extract old ones.

Note

Usually, the user of the library should not create new formats and, instead, use the ones provided by the BitFormat namespace.

Constructor & Destructor Documentation

BitInOutFormat()

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

inlineconstexprnoexcept

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

Member Function Documentation

defaultMethod()

auto defaultMethod ( ) const -> BitCompressionMethod

noexcept

Returns

the default method used for compressing the archive format.

extension()

auto extension ( ) const -> const tchar *

noexcept

Returns

the default file extension of the archive format.

features()

auto features ( ) const -> FormatFeatures

noexcept

Returns

the bitset of the features supported by the format.

hasFeature()

auto hasFeature ( FormatFeatures  feature ) const -> bool

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.

operator!=()

auto operator!= ( BitInFormat const &  other ) const -> bool

noexceptinherited

Parameters

other

the target object to compare to.

Returns

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

operator==()

auto operator== ( BitInFormat const &  other ) const -> bool

noexceptinherited

Parameters

other

the target object to compare to.

Returns

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

value()

auto value ( ) const -> unsigned char

noexceptinherited

Returns

the value of the format in the 7z SDK.

---

The documentation for this class was generated from the following file:

• include/bit7z/bitformat.hpp