Skip to content

Encoder

INCLUDE FILE
#include "Encoder.h"

class Encoder

Represents an encoder, which is responsible for encoding values into bytes. This is the class other parts of the program interact with. This class is a wrapper around the BaseEncoder hierarchy.

DEFINITION
class Encoder;

constructor Encoder

DEFINITION
Encoder ( const IntegerEncoder & encoder );
PARAMETERDESCRIPTION
encoder

constructor Encoder

DEFINITION
Encoder ( const StringEncoding * string_encoding,
std::optional< size_t >  size = {} );
PARAMETERDESCRIPTION
string_encoding
size

constructor Encoder

DEFINITION
Encoder ( Tokenizer & tokenizer );
PARAMETERDESCRIPTION
tokenizer

constructor Encoder

DEFINITION
Encoder ( const Value & value );
PARAMETERDESCRIPTION
value

method as_binary_encoderconst

DEFINITION
const BinaryEncoder * as_binary_encoder ( ) const;
RETURNSDESCRIPTION
const BinaryEncoder *

method as_integer_encoderconst

DEFINITION
const IntegerEncoder * as_integer_encoder ( ) const;
RETURNSDESCRIPTION
const IntegerEncoder *

method as_string_encoderconst

DEFINITION
const StringEncoder * as_string_encoder ( ) const;
RETURNSDESCRIPTION
const StringEncoder *

method encodeconst

DEFINITION
void  encode ( std::string & bytes,
const Value & value ) const;
PARAMETERDESCRIPTION
bytes
value

method encoded_sizeconst

DEFINITION
size_t  encoded_size ( const Value & value ) const;
PARAMETERDESCRIPTION
value
RETURNSDESCRIPTION
size_t

method fitsconst

DEFINITION
bool  fits ( const Value & value ) const;
PARAMETERDESCRIPTION
value
RETURNSDESCRIPTION
bool

method is_binary_encoderconst

DEFINITION
bool  is_binary_encoder ( ) const;
RETURNSDESCRIPTION
bool

method is_integer_encoderconst

DEFINITION
bool  is_integer_encoder ( ) const;
RETURNSDESCRIPTION
bool

method is_natural_encoderconst

DEFINITION
bool  is_natural_encoder ( const Value & value ) const;
PARAMETERDESCRIPTION
value
RETURNSDESCRIPTION
bool

method is_string_encoderconst

DEFINITION
bool  is_string_encoder ( ) const;
RETURNSDESCRIPTION
bool

method operator==const

DEFINITION
bool  operator== ( const Encoder & other ) const;
PARAMETERDESCRIPTION
other
RETURNSDESCRIPTION
bool

method operator==const

DEFINITION
bool  operator== ( const IntegerEncoder & other ) const;
PARAMETERDESCRIPTION
other
RETURNSDESCRIPTION
bool

method serializeconst

DEFINITION
void  serialize ( std::ostream & stream ) const;
PARAMETERDESCRIPTION
stream

method size_rangeconst

DEFINITION
SizeRange  size_range ( ) const;
RETURNSDESCRIPTION
SizeRange

member encoderprivate

DEFINITION
std::shared_ptr< BaseEncoder >  encoder;