duckdb::AllocatedData Class Reference

Collaboration diagram for duckdb::AllocatedData:

Public Member Functions
DUCKDB_API	AllocatedData (Allocator &allocator, data_ptr_t pointer, idx_t allocated_size)
	AllocatedData (const AllocatedData &other)=delete
AllocatedData &	operator= (const AllocatedData &)=delete
DUCKDB_API	AllocatedData (AllocatedData &&other) noexcept
	enable move constructors
DUCKDB_API AllocatedData &	operator= (AllocatedData &&) noexcept
data_ptr_t	get ()
	operator bool () const
const_data_ptr_t	get () const
idx_t	GetSize () const
bool	IsSet ()
optional_ptr< Allocator >	GetAllocator () const
void	Reset ()

Private Attributes
optional_ptr< Allocator >	allocator
data_ptr_t	pointer
idx_t	allocated_size

Constructor & Destructor Documentation

AllocatedData() [1/3]

duckdb::AllocatedData::AllocatedData

(

)

                             : allocator(nullptr), pointer(nullptr), allocated_size(0) {
}

AllocatedData() [2/3]

duckdb::AllocatedData::AllocatedData	(	Allocator &	allocator,
		data_ptr_t	pointer,
		idx_t	allocated_size
	)

    : allocator(&allocator), pointer(pointer), allocated_size(allocated_size) {
    if (!pointer) {
        throw InternalException("AllocatedData object constructed with nullptr");
    }
}

~AllocatedData()

duckdb::AllocatedData::~AllocatedData

(

)

                              {
    Reset();
}

AllocatedData() [3/3]

duckdb::AllocatedData::AllocatedData ( AllocatedData &&  other )

noexcept

enable move constructors

    : allocator(other.allocator), pointer(nullptr), allocated_size(0) {
    std::swap(pointer, other.pointer);
    std::swap(allocated_size, other.allocated_size);
}

Member Function Documentation

operator=()

AllocatedData & duckdb::AllocatedData::operator= ( AllocatedData &&  other )

noexcept

                                                                      {
    std::swap(allocator, other.allocator);
    std::swap(pointer, other.pointer);
    std::swap(allocated_size, other.allocated_size);
    return *this;
}

get() [1/2]

data_ptr_t duckdb::AllocatedData::get ( )

inline

                     { // NOLINT: matching std style
        return pointer;
    }

operator bool()

duckdb::AllocatedData::operator bool ( ) const

inline

                          { // NOLINT: missing explicit
        return pointer != nullptr;
    }

get() [2/2]

const_data_ptr_t duckdb::AllocatedData::get ( ) const

inline

                                 { // NOLINT: matching std style
        return pointer;
    }

GetSize()

idx_t duckdb::AllocatedData::GetSize ( ) const

inline

                          {
        return allocated_size;
    }

IsSet()

bool duckdb::AllocatedData::IsSet ( )

inline

                 {
        return pointer;
    }

GetAllocator()

optional_ptr< Allocator > duckdb::AllocatedData::GetAllocator ( ) const

inline

                                                 {
        return allocator;
    }

Reset()

void duckdb::AllocatedData::Reset

(

)

                          {
    if (!pointer) {
        return;
    }
    D_ASSERT(allocator);
    allocator->FreeData(pointer, allocated_size);
    allocated_size = 0;
    pointer = nullptr;
}

---

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

• external/duckdb/duckdb.hpp
• external/duckdb/duckdb.cpp