duckdb::EncodingFunction Class Reference

Collaboration diagram for duckdb::EncodingFunction:

Public Member Functions
DUCKDB_API	EncodingFunction (const string &encode_name, encode_t encode_function, const idx_t bytes_per_iteration, const idx_t lookup_bytes)
DUCKDB_API	EncodingFunction (const string &encode_name, encode_t encode_function, const idx_t bytes_per_iteration, const idx_t lookup_bytes, const map_entry_encoding *map, const size_t map_size)
DUCKDB_API string	GetName () const
DUCKDB_API encode_t	GetFunction () const
DUCKDB_API idx_t	GetBytesPerIteration () const
DUCKDB_API idx_t	GetLookupBytes () const

Public Attributes
const map_entry_encoding *	conversion_map {}
	Optional convertion map, that indicates byte replacements.
size_t	map_size {}

Protected Attributes
string	name
	The encoding type of this function (e.g., utf-8)
encode_t	encode_function
	The actual encoding function.
idx_t	max_bytes_per_iteration
idx_t	lookup_bytes = 1
	How many bytes we have to lookup before knowing the bytes we have to output.

Constructor & Destructor Documentation

EncodingFunction() [1/3]

DUCKDB_API duckdb::EncodingFunction::EncodingFunction ( )

inline

                                  : encode_function(nullptr), max_bytes_per_iteration(0) {
    }

EncodingFunction() [2/3]

DUCKDB_API duckdb::EncodingFunction::EncodingFunction ( const string &  encode_name, encode_t  encode_function, const idx_t  bytes_per_iteration, const idx_t  lookup_bytes  )

inline

        : name(encode_name), encode_function(encode_function), max_bytes_per_iteration(bytes_per_iteration),
          lookup_bytes(lookup_bytes) {
        D_ASSERT(encode_function);
        D_ASSERT(bytes_per_iteration > 0);
        D_ASSERT(lookup_bytes > 0);
    };

EncodingFunction() [3/3]

DUCKDB_API duckdb::EncodingFunction::EncodingFunction ( const string &  encode_name, encode_t  encode_function, const idx_t  bytes_per_iteration, const idx_t  lookup_bytes, const map_entry_encoding *  map, const size_t  map_size  )

inline

        : conversion_map(map), map_size(map_size), name(encode_name), encode_function(encode_function),
          max_bytes_per_iteration(bytes_per_iteration), lookup_bytes(lookup_bytes) {
        D_ASSERT(encode_function);
        D_ASSERT(bytes_per_iteration > 0);
        D_ASSERT(lookup_bytes > 0);
    };

~EncodingFunction()

DUCKDB_API duckdb::EncodingFunction::~EncodingFunction ( )

inline

{};

Member Function Documentation

GetName()

DUCKDB_API string duckdb::EncodingFunction::GetName ( ) const

inline

                                      {
        return name;
    }

GetFunction()

DUCKDB_API encode_t duckdb::EncodingFunction::GetFunction ( ) const

inline

                                            {
        return encode_function;
    }

GetBytesPerIteration()

DUCKDB_API idx_t duckdb::EncodingFunction::GetBytesPerIteration ( ) const

inline

                                                  {
        return max_bytes_per_iteration;
    }

GetLookupBytes()

DUCKDB_API idx_t duckdb::EncodingFunction::GetLookupBytes ( ) const

inline

                                            {
        return lookup_bytes;
    }

Member Data Documentation

conversion_map

const map_entry_encoding* duckdb::EncodingFunction::conversion_map {}

Optional convertion map, that indicates byte replacements.

{};

map_size

size_t duckdb::EncodingFunction::map_size {}

{};

max_bytes_per_iteration

idx_t duckdb::EncodingFunction::max_bytes_per_iteration

protected

How many bytes in the decoded buffer one iteration of the encoded function can cause. e.g., one iteration of Latin-1 to UTF-8 can generate max 2 bytes. However, one iteration of UTF-16 to UTF-8, can generate up to 3 UTF-8 bytes.

---

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

• external/duckdb/duckdb.hpp