MySQL  8.0.20
Source Code Documentation
page_size_t Class Reference

Page size descriptor. More...

#include <page0size.h>

Public Member Functions

 page_size_t (uint32_t physical, uint32_t logical, bool is_compressed)
 Constructor from (physical, logical, is_compressed). More...
 
 page_size_t (uint32_t fsp_flags)
 Constructor from (fsp_flags). More...
 
size_t physical () const
 Retrieve the physical page size (on-disk). More...
 
size_t logical () const
 Retrieve the logical page size (in-memory). More...
 
page_no_t extent_size () const
 
size_t extents_per_xdes () const
 
bool is_compressed () const
 Check whether the page is compressed on disk. More...
 
void copy_from (const page_size_t &src)
 Copy the values from a given page_size_t object. More...
 
bool equals_to (const page_size_t &a) const
 Check if a given page_size_t object is equal to the current one. More...
 
void set_flag (uint32_t fsp_flags)
 
void operator= (const page_size_t &)=delete
 
 page_size_t (const page_size_t &)=default
 

Private Attributes

unsigned m_physical: PAGE_SIZE_T_SIZE_BITS
 Physical page size. More...
 
unsigned m_logical: PAGE_SIZE_T_SIZE_BITS
 Logical page size. More...
 
unsigned m_is_compressed: 1
 Flag designating whether the physical page is compressed, which is true IFF the whole tablespace where the page belongs is compressed. More...
 

Detailed Description

Page size descriptor.

Contains the physical and logical page size, as well as whether the page is compressed or not.

Constructor & Destructor Documentation

◆ page_size_t() [1/3]

page_size_t::page_size_t ( uint32_t  physical,
uint32_t  logical,
bool  is_compressed 
)
inline

Constructor from (physical, logical, is_compressed).

Parameters
[in]physicalphysical (on-disk/zipped) page size
[in]logicallogical (in-memory/unzipped) page size
[in]is_compressedwhether the page is compressed

◆ page_size_t() [2/3]

page_size_t::page_size_t ( uint32_t  fsp_flags)
inlineexplicit

Constructor from (fsp_flags).

Parameters
[in]fsp_flagsfilespace flags

◆ page_size_t() [3/3]

page_size_t::page_size_t ( const page_size_t )
default

Member Function Documentation

◆ copy_from()

void page_size_t::copy_from ( const page_size_t src)
inline

Copy the values from a given page_size_t object.

Parameters
[in]srcpage size object whose values to fetch

◆ equals_to()

bool page_size_t::equals_to ( const page_size_t a) const
inline

Check if a given page_size_t object is equal to the current one.

Parameters
[in]apage_size_t object to compare
Returns
true if equal

◆ extent_size()

page_no_t page_size_t::extent_size ( ) const
inline

◆ extents_per_xdes()

size_t page_size_t::extents_per_xdes ( ) const
inline

◆ is_compressed()

bool page_size_t::is_compressed ( ) const
inline

Check whether the page is compressed on disk.

Returns
true if compressed

◆ logical()

size_t page_size_t::logical ( ) const
inline

Retrieve the logical page size (in-memory).

Returns
logical page size in bytes

◆ operator=()

void page_size_t::operator= ( const page_size_t )
delete

◆ physical()

size_t page_size_t::physical ( ) const
inline

Retrieve the physical page size (on-disk).

Returns
physical page size in bytes

◆ set_flag()

void page_size_t::set_flag ( uint32_t  fsp_flags)
inline

Member Data Documentation

◆ m_is_compressed

unsigned page_size_t::m_is_compressed
private

Flag designating whether the physical page is compressed, which is true IFF the whole tablespace where the page belongs is compressed.

◆ m_logical

unsigned page_size_t::m_logical
private

Logical page size.

◆ m_physical

unsigned page_size_t::m_physical
private

Physical page size.


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