duckdb::optional_idx Class Reference

Public Member Functions
	optional_idx (idx_t index)
bool	IsValid () const
void	SetInvalid ()
idx_t	GetIndex () const
bool	operator== (const optional_idx &rhs) const
bool	operator!= (const optional_idx &rhs) const

Static Public Member Functions
static optional_idx	Invalid ()

Private Attributes
idx_t	index

Static Private Attributes
static constexpr const idx_t	INVALID_INDEX = idx_t(-1)

Constructor & Destructor Documentation

optional_idx() [1/2]

duckdb::optional_idx::optional_idx ( )

inline

                   : index(INVALID_INDEX) {
    }

optional_idx() [2/2]

duckdb::optional_idx::optional_idx ( idx_t  index )

inline

                              : index(index) { // NOLINT: allow implicit conversion from idx_t
        if (index == INVALID_INDEX) {
            throw InternalException("optional_idx cannot be initialized with an invalid index");
        }
    }

Member Function Documentation

Invalid()

static optional_idx duckdb::optional_idx::Invalid ( )

inlinestatic

                                  {
        return optional_idx();
    }

IsValid()

bool duckdb::optional_idx::IsValid ( ) const

inline

                         {
        return index != INVALID_INDEX;
    }

SetInvalid()

void duckdb::optional_idx::SetInvalid ( )

inline

                      {
        index = INVALID_INDEX;
    }

GetIndex()

idx_t duckdb::optional_idx::GetIndex ( ) const

inline

                           {
        if (index == INVALID_INDEX) {
            throw InternalException("Attempting to get the index of an optional_idx that is not set");
        }
        return index;
    }

operator==()

bool duckdb::optional_idx::operator== ( const optional_idx &  rhs ) const

inline

                                                          {
        return index == rhs.index;
    }

operator!=()

bool duckdb::optional_idx::operator!= ( const optional_idx &  rhs ) const

inline

                                                          {
        return index != rhs.index;
    }

---

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

• external/duckdb/duckdb.hpp