Implements an encoder that encodes integer values, taking into account the minimum size and byte order.
DEFINITION
class IntegerEncoder;
The value range accepted.
| VALUE | DESCRIPTION |
SIGNED |
Accepts values in the range of two's complement signed integers.
|
UNSIGNED |
Accepts values in the range of unsigned integers.
|
EITHER |
Accepts values in the range of both signed and unsigned integers.
|
DEFINITION
|
IntegerEncoder |
( |
Type type, |
| | std::optional< size_t > size, |
| | std::optional< uint64_t > byte_order = {} | ); |
| PARAMETER | DESCRIPTION |
|---|
type |
|
size |
|
byte_order |
|
DEFINITION
|
IntegerEncoder |
( |
const Value & value | ); |
| PARAMETER | DESCRIPTION |
|---|
value |
|
DEFINITION
|
uint64_t byte_order |
( |
) const; |
| RETURNS | DESCRIPTION |
|---|
uint64_t |
|
DEFINITION
|
std::optional< size_t > byte_size |
( |
) const; |
| RETURNS | DESCRIPTION |
|---|
std::optional< size_t > |
|
DEFINITION
|
static uint64_t default_byte_order |
( |
); |
| RETURNS | DESCRIPTION |
|---|
uint64_t |
|
DEFINITION
|
virtual void encode |
( |
std::string & bytes, |
| | const Value & value | ) const; |
| PARAMETER | DESCRIPTION |
|---|
bytes |
|
value |
|
DEFINITION
|
virtual size_t encoded_size |
( |
const Value & value | ) const; |
| PARAMETER | DESCRIPTION |
|---|
value |
|
| RETURNS | DESCRIPTION |
|---|
size_t |
|
DEFINITION
|
virtual bool fits |
( |
const Value & value | ) const; |
| PARAMETER | DESCRIPTION |
|---|
value |
|
DEFINITION
|
virtual bool is_natural_encoder |
( |
const Value & value | ) const; |
| PARAMETER | DESCRIPTION |
|---|
value |
|
DEFINITION
|
std::optional< Value > maximum_value |
( |
) const; |
| RETURNS | DESCRIPTION |
|---|
std::optional< Value > |
|
DEFINITION
|
std::optional< Value > minimum_value |
( |
) const; |
| RETURNS | DESCRIPTION |
|---|
std::optional< Value > |
|
DEFINITION
|
bool operator!= |
( |
const IntegerEncoder & other | ) const; |
| PARAMETER | DESCRIPTION |
|---|
other |
|
DEFINITION
|
virtual bool operator== |
( |
const Encoder & other | ) const; |
| PARAMETER | DESCRIPTION |
|---|
other |
|
DEFINITION
|
bool operator== |
( |
const IntegerEncoder & other | ) const; |
| PARAMETER | DESCRIPTION |
|---|
other |
|
DEFINITION
|
virtual void serialize |
( |
std::ostream & stream | ) const; |
| PARAMETER | DESCRIPTION |
|---|
stream |
|
DEFINITION
|
virtual SizeRange size_range |
( |
) const; |
| RETURNS | DESCRIPTION |
|---|
SizeRange |
|
DEFINITION
static const uint64_t big_endian_byte_order;
DEFINITION
std::optional< uint64_t > explicit_byte_order;
DEFINITION
static const uint64_t little_endian_byte_order;
DEFINITION
std::optional< size_t > size;