MySQL 9.1.0
Source Code Documentation
Fil_page_header Struct Reference

A wrapper class to help print and inspect the file page header. More...

#include <fil0types.h>

Public Member Functions

 Fil_page_header (const byte *frame)
 The constructor that takes a pointer to page header as argument. More...
 
space_id_t get_space_id () const noexcept
 Get the space id from the page header. More...
 
page_no_t get_page_no () const noexcept
 Get the page number from the page header. More...
 
page_no_t get_page_prev () const noexcept
 Get the FIL_PAGE_PREV header value. More...
 
page_no_t get_page_next () const noexcept
 Get the FIL_PAGE_NEXT header value. More...
 
uint16_t get_page_type () const noexcept
 Get the page type from the page header. More...
 
std::ostream & print (std::ostream &out) const noexcept
 Print the page header to the given output stream. More...
 

Private Attributes

const bytem_frame {}
 Pointer to the page header. More...
 

Detailed Description

A wrapper class to help print and inspect the file page header.

Constructor & Destructor Documentation

◆ Fil_page_header()

Fil_page_header::Fil_page_header ( const byte frame)
inlineexplicit

The constructor that takes a pointer to page header as argument.

Parameters
[in]framethe pointer to the page header.

Member Function Documentation

◆ get_page_next()

page_no_t Fil_page_header::get_page_next ( ) const
noexcept

Get the FIL_PAGE_NEXT header value.

Returns
the next page number.

◆ get_page_no()

page_no_t Fil_page_header::get_page_no ( ) const
noexcept

Get the page number from the page header.

Returns
the page number.

◆ get_page_prev()

page_no_t Fil_page_header::get_page_prev ( ) const
noexcept

Get the FIL_PAGE_PREV header value.

Returns
the previous page number.

◆ get_page_type()

uint16_t Fil_page_header::get_page_type ( ) const
noexcept

Get the page type from the page header.

Returns
the page type.

◆ get_space_id()

space_id_t Fil_page_header::get_space_id ( ) const
noexcept

Get the space id from the page header.

Returns
the space identifier.

◆ print()

std::ostream & Fil_page_header::print ( std::ostream &  out) const
noexcept

Print the page header to the given output stream.

Parameters
[in]outthe output stream.
Returns
the output stream.

Member Data Documentation

◆ m_frame

const byte* Fil_page_header::m_frame {}
private

Pointer to the page header.


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