duckdb::IteratorKey Class Reference

Keeps track of the current key in the iterator leading down to the top node in the stack. More...

Collaboration diagram for duckdb::IteratorKey:

Public Member Functions
void	Push (const uint8_t key_byte)
	Pushes a byte into the current key.
void	Pop (const idx_t n)
	Pops n bytes from the current key.
uint8_t &	operator[] (idx_t idx)
	Returns the byte at idx.
idx_t	Size () const
const_data_ptr_t	Data () const
	Returns a pointer to the key bytes.
bool	Contains (const ARTKey &key) const
	Returns true, if key_bytes contains all bytes of key.
bool	GreaterThan (const ARTKey &key, const bool equal, const uint8_t nested_depth) const
	Returns true, if key_bytes is greater than [or equal to] the key.

Private Attributes
unsafe_vector< uint8_t >	key_bytes

Detailed Description

Keeps track of the current key in the iterator leading down to the top node in the stack.

Member Function Documentation

Push()

void duckdb::IteratorKey::Push ( const uint8_t  key_byte )

inline

Pushes a byte into the current key.

                                             {
        key_bytes.push_back(key_byte);
    }

Pop()

void duckdb::IteratorKey::Pop ( const idx_t  n )

inline

Pops n bytes from the current key.

                                   {
        key_bytes.resize(key_bytes.size() - n);
    }

operator[]()

uint8_t & duckdb::IteratorKey::operator[] ( idx_t  idx )

inline

Returns the byte at idx.

                                          {
        D_ASSERT(idx < key_bytes.size());
        return key_bytes[idx];
    }

Size()

idx_t duckdb::IteratorKey::Size ( ) const

inline

                              {
        return key_bytes.size();
    }

Data()

const_data_ptr_t duckdb::IteratorKey::Data ( ) const

inline

Returns a pointer to the key bytes.

                                         {
        return const_data_ptr_cast(key_bytes.data());
    }

---

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

• external/duckdb/duckdb.cpp