Class BitInFormat
Synopsis
#include <include/bitformat.hpp>
class BitInFormat
Description
The BitInFormat class specifies an extractable archive format.
- Note
- Usually, the user of the library should not create new formats and, instead, use the ones provided by the BitFormat namespace.
Inheritance
Decsendents: BitInOutFormat
Methods
| BitInFormat | Constructs a BitInFormat object with the id value used by the 7z SDK. | |
| guid | Returns: the GUID that identifies the file format in the 7z SDK. | |
| operator!= | Returns: true if this format is not equal to "other". | |
| operator== | Returns: true if this format is equal to "other". | |
| value | Returns: the value of the format in the 7z SDK. |
Source
Lines 53-95 in include/bitformat.hpp.
class BitInFormat {
public:
/**
* @brief Constructs a BitInFormat object with the id value used by the 7z SDK.
* @param value the value of the format in the 7z SDK.
*/
explicit BitInFormat( unsigned char value );
/**
* @return the value of the format in the 7z SDK.
*/
int value() const;
/**
* @return the GUID that identifies the file format in the 7z SDK.
*/
const GUID guid() const;
/**
* @param other the target object to compare to.
* @return true if this format is equal to "other".
*/
bool operator==( BitInFormat const& other ) const;
/**
* @param other the target object to compare to.
* @return true if this format is not equal to "other".
*/
bool operator!=( BitInFormat const& other ) const;
private:
const unsigned char mValue;
//non-copyable
BitInFormat( const BitInFormat& other );
BitInFormat& operator=( const BitInFormat& other );
//non-movable
BitInFormat( BitInFormat&& other );
BitInFormat& operator=( BitInFormat&& other );
};