Inheritance diagram for duckdb::ValidityMask:

Collaboration diagram for duckdb::ValidityMask:

[legend]

Public Member Functions
	ValidityMask (idx_t capacity)

	ValidityMask (validity_t *ptr, idx_t capacity)

	ValidityMask (const ValidityMask &original, idx_t count)

DUCKDB_API void	Resize (idx_t new_size)

DUCKDB_API idx_t	Capacity () const

DUCKDB_API void	SliceInPlace (const ValidityMask &other, idx_t target_offset, idx_t source_offset, idx_t count)

DUCKDB_API void	Slice (const ValidityMask &other, idx_t source_offset, idx_t count)

DUCKDB_API void	CopySel (const ValidityMask &other, const SelectionVector &sel, idx_t source_offset, idx_t target_offset, idx_t count)

DUCKDB_API void	Combine (const ValidityMask &other, idx_t count)

DUCKDB_API string	ToString (idx_t count) const

DUCKDB_API string	ToString () const

void	Write (WriteStream &writer, idx_t count)

void	Read (ReadStream &reader, idx_t count)

Public Member Functions inherited from duckdb::TemplatedValidityMask< validity_t >
	TemplatedValidityMask (idx_t target_count)

	TemplatedValidityMask (validity_t *ptr, idx_t capacity)

	TemplatedValidityMask (const TemplatedValidityMask &original, idx_t count)

bool	AllValid () const

bool	CheckAllValid (idx_t count) const

bool	CheckAllValid (idx_t to, idx_t from) const

bool	CheckAllInvalid (idx_t count) const

idx_t	CountValid (const idx_t count) const

validity_t *	GetData () const

void	Reset (idx_t target_count_p=STANDARD_VECTOR_SIZE)

validity_t	GetValidityEntry (idx_t entry_idx) const

validity_t &	GetValidityEntryUnsafe (idx_t entry_idx) const

bool	RowIsValid (idx_t row_idx) const
	Returns true if a row is valid (i.e. not null), false otherwise.

bool	RowIsValidUnsafe (idx_t row_idx) const

void	SetValidUnsafe (idx_t row_idx)
	Same as SetValid, but skips a null check on validity_mask.

void	SetValid (idx_t row_idx)
	Marks the entry at the specified row index as valid (i.e. not-null)

void	SetInvalidUnsafe (idx_t entry_idx, idx_t idx_in_entry)
	Marks the bit at the specified entry as invalid (i.e. null)

void	SetInvalidUnsafe (idx_t row_idx)
	Marks the bit at the specified row index as invalid (i.e. null)

void	SetInvalid (idx_t row_idx)
	Marks the entry at the specified row index as invalid (i.e. null)

void	Set (idx_t row_idx, bool valid)
	Mark the entry at the specified index as either valid or invalid (non-null or null)

void	EnsureWritable ()
	Ensure the validity mask is writable, allocating space if it is not initialized.

void	SetRangeInvalid (const idx_t count, const idx_t begin_entry, const idx_t end_entry)

void	SetAllInvalid (idx_t count)
	Marks exactly "count" bits in the validity mask as invalid (null)

void	SetAllValid (idx_t count)
	Marks exactly "count" bits in the validity mask as valid (not null)

bool	IsMaskSet () const

void	Initialize (validity_t *validity, idx_t new_capacity)

void	Initialize (const TemplatedValidityMask &other)

void	Initialize (idx_t count)

void	Initialize ()

void	Copy (const TemplatedValidityMask &other, idx_t count)

Static Public Member Functions
static DUCKDB_API bool	IsAligned (idx_t count)

Static Public Member Functions inherited from duckdb::TemplatedValidityMask< validity_t >
static idx_t	ValidityMaskSize (idx_t count=STANDARD_VECTOR_SIZE)

static bool	AllValid (validity_t entry)

static idx_t	EntryCount (idx_t count)

static bool	NoneValid (validity_t entry)

static bool	RowIsValid (const validity_t &entry, const idx_t &idx_in_entry)

static void	GetEntryIndex (idx_t row_idx, idx_t &entry_idx, idx_t &idx_in_entry)

static validity_t	EntryWithValidBits (idx_t n)
	Get an entry that has first-n bits set as valid and rest set as invalid.

static idx_t	SizeInBytes (idx_t n)

Additional Inherited Members
Public Types inherited from duckdb::TemplatedValidityMask< validity_t >
using	ValidityBuffer = TemplatedValidityData< validity_t >

Static Public Attributes inherited from duckdb::TemplatedValidityMask< validity_t >
static constexpr const idx_t	BITS_PER_VALUE

static constexpr const idx_t	STANDARD_ENTRY_COUNT

static constexpr const idx_t	STANDARD_MASK_SIZE

Protected Attributes inherited from duckdb::TemplatedValidityMask< validity_t >
validity_t *	validity_mask

buffer_ptr< ValidityBuffer >	validity_data

idx_t	capacity

Constructor & Destructor Documentation

◆ ValidityMask() [1/4]

duckdb::ValidityMask::ValidityMask ( )

inline

9283 : TemplatedValidityMask(nullptr, STANDARD_VECTOR_SIZE) {

9284 }

◆ ValidityMask() [2/4]

duckdb::ValidityMask::ValidityMask ( idx_t capacity )

inlineexplicit

9285 : TemplatedValidityMask(capacity) {

9286 }

◆ ValidityMask() [3/4]

duckdb::ValidityMask::ValidityMask	(	validity_t *	ptr,
		idx_t	capacity
	)

inlineexplicit

9287 : TemplatedValidityMask(ptr, capacity) {

9288 }

◆ ValidityMask() [4/4]

duckdb::ValidityMask::ValidityMask	(	const ValidityMask &	original,
		idx_t	count
	)

inline

9289 : TemplatedValidityMask(original, count) {

9290 }

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

external/duckdb/duckdb.hpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ ValidityMask() [1/4]

◆ ValidityMask() [2/4]

◆ ValidityMask() [3/4]

◆ ValidityMask() [4/4]