pineforge::detail::FixedMemoryScratchBacking Class Reference

#include <scratch_backing.hpp>

Public Member Functions
	FixedMemoryScratchBacking (ScratchBuffer storage, std::size_t page_size, ScratchIoObserver observer={}) noexcept
ScratchStatus	status () const noexcept
std::uint64_t	capacity_pages () const noexcept
std::uint64_t	page_count () const noexcept override
Public Member Functions inherited from pineforge::detail::ScratchBacking
virtual	~ScratchBacking () noexcept=default
	ScratchBacking (const ScratchBacking &)=delete
ScratchBacking &	operator= (const ScratchBacking &)=delete
	ScratchBacking (ScratchBacking &&)=delete
ScratchBacking &	operator= (ScratchBacking &&)=delete
ScratchBackingKind	kind () const noexcept
std::size_t	page_size () const noexcept
virtual std::optional< std::uint64_t >	arena_capacity_bytes () const noexcept
virtual const ReportScratchIoError *	carried_failure () const noexcept
ScratchStatus	read_page (ScratchPageId id, ScratchBuffer destination) const noexcept
ScratchStatus	write_page (ScratchPageId id, ScratchBytes source) noexcept
ScratchStatus	sync (ScratchDurability durability) noexcept

Protected Member Functions
ScratchStatus	do_read_page (ScratchPageId id, ScratchBuffer destination) const noexcept override
ScratchStatus	do_write_page (ScratchPageId id, ScratchBytes source) noexcept override
ScratchStatus	do_sync (ScratchDurability durability) noexcept override
Protected Member Functions inherited from pineforge::detail::ScratchBacking
	ScratchBacking (ScratchBackingKind kind, std::size_t page_size, ScratchIoObserver observer={}) noexcept

Detailed Description

Definition at line 162 of file scratch_backing.hpp.

Constructor & Destructor Documentation

FixedMemoryScratchBacking()

pineforge::detail::FixedMemoryScratchBacking::FixedMemoryScratchBacking ( ScratchBuffer storage, std::size_t page_size, ScratchIoObserver observer = {} )

inlinenoexcept

Definition at line 164 of file scratch_backing.hpp.

References pineforge::detail::ScratchBacking::page_size().

Member Function Documentation

status()

ScratchStatus pineforge::detail::FixedMemoryScratchBacking::status ( ) const

inlinenoexcept

Definition at line 169 of file scratch_backing.hpp.

References pineforge::detail::ok, pineforge::detail::ScratchBacking::page_size(), and pineforge::detail::programming_error.

Referenced by do_read_page(), do_sync(), and do_write_page().

capacity_pages()

std::uint64_t pineforge::detail::FixedMemoryScratchBacking::capacity_pages ( ) const

inlinenoexcept

Definition at line 174 of file scratch_backing.hpp.

References pineforge::detail::ScratchBacking::page_size().

Referenced by do_write_page().

page_count()

std::uint64_t pineforge::detail::FixedMemoryScratchBacking::page_count ( ) const

inlineoverridevirtualnoexcept

Implements pineforge::detail::ScratchBacking.

Definition at line 177 of file scratch_backing.hpp.

do_read_page()

ScratchStatus pineforge::detail::FixedMemoryScratchBacking::do_read_page ( ScratchPageId id, ScratchBuffer destination ) const

inlineoverrideprotectedvirtualnoexcept

Implements pineforge::detail::ScratchBacking.

Definition at line 180 of file scratch_backing.hpp.

References pineforge::detail::not_found, pineforge::detail::ok, pineforge::detail::ScratchBacking::page_size(), pineforge::detail::programming_error, and status().

do_write_page()

ScratchStatus pineforge::detail::FixedMemoryScratchBacking::do_write_page ( ScratchPageId id, ScratchBytes source )

inlineoverrideprotectedvirtualnoexcept

Implements pineforge::detail::ScratchBacking.

Definition at line 187 of file scratch_backing.hpp.

References capacity_pages(), pineforge::detail::ok, pineforge::detail::ScratchBacking::page_size(), pineforge::detail::programming_error, and status().

do_sync()

ScratchStatus pineforge::detail::FixedMemoryScratchBacking::do_sync ( ScratchDurability durability )

inlineoverrideprotectedvirtualnoexcept

Implements pineforge::detail::ScratchBacking.

Definition at line 199 of file scratch_backing.hpp.

References pineforge::detail::buffered, pineforge::detail::ok, pineforge::detail::programming_error, and status().

---

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

• scratch_backing.hpp