duckdb::BufferHandle Class Reference

Collaboration diagram for duckdb::BufferHandle:

Public Member Functions
DUCKDB_API	BufferHandle (shared_ptr< BlockHandle > handle, optional_ptr< FileBuffer > node)
	BufferHandle (const BufferHandle &other)=delete
BufferHandle &	operator= (const BufferHandle &)=delete
DUCKDB_API	BufferHandle (BufferHandle &&other) noexcept
	enable move constructors
DUCKDB_API BufferHandle &	operator= (BufferHandle &&) noexcept
DUCKDB_API bool	IsValid () const
	Returns whether or not the BufferHandle is valid.
data_ptr_t	Ptr () const
	Returns a pointer to the buffer data. Handle must be valid.
data_ptr_t	Ptr ()
	Returns a pointer to the buffer data. Handle must be valid.
DUCKDB_API FileBuffer &	GetFileBuffer ()
	Gets the underlying file buffer. Handle must be valid.
DUCKDB_API void	Destroy ()
	Destroys the buffer handle.
const shared_ptr< BlockHandle > &	GetBlockHandle () const

Private Attributes
shared_ptr< BlockHandle >	handle
	The block handle.
optional_ptr< FileBuffer >	node
	The managed buffer node.

Member Function Documentation

Ptr() [1/2]

data_ptr_t duckdb::BufferHandle::Ptr ( ) const

inline

Returns a pointer to the buffer data. Handle must be valid.

                                  {
        D_ASSERT(IsValid());
        return node->buffer;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Ptr() [2/2]

data_ptr_t duckdb::BufferHandle::Ptr ( )

inline

Returns a pointer to the buffer data. Handle must be valid.

                            {
        D_ASSERT(IsValid());
        return node->buffer;
    }

Here is the call graph for this function:

GetBlockHandle()

const shared_ptr< BlockHandle > & duckdb::BufferHandle::GetBlockHandle ( ) const

inline

                                                          {
        return handle;
    }

---

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

• external/duckdb/duckdb.hpp