pineforge::detail::journal_codec::Reader Struct Reference

#include <journal_codec.hpp>

Public Member Functions
std::uint64_t	remaining () const noexcept
void	bytes (void *destination, std::size_t length) noexcept
void	skip (std::uint64_t length) noexcept
std::uint64_t	word () noexcept
bool	presence () noexcept
template<class T>
void	integer (T &out) noexcept
void	real (double &out) noexcept
void	text (std::string &out, bool owning)
ScratchStatus	finish () const noexcept

Data Fields
const ScratchByteSource &	source
ScratchBuffer	page
std::uint64_t	position = 0
ScratchStatus	status = ScratchStatus::ok
std::uint64_t	cached_at = 0
std::size_t	cached_size = 0

Detailed Description

Definition at line 75 of file journal_codec.hpp.

Member Function Documentation

remaining()

std::uint64_t pineforge::detail::journal_codec::Reader::remaining ( ) const

inlinenoexcept

Definition at line 83 of file journal_codec.hpp.

References position, and source.

Referenced by bytes(), skip(), and text().

bytes()

void pineforge::detail::journal_codec::Reader::bytes ( void * destination, std::size_t length )

inlinenoexcept

Definition at line 86 of file journal_codec.hpp.

References cached_at, cached_size, pineforge::detail::corrupt, pineforge::detail::ok, page, position, pineforge::detail::programming_error, remaining(), source, and status.

Referenced by presence(), text(), and word().

skip()

void pineforge::detail::journal_codec::Reader::skip ( std::uint64_t length )

inlinenoexcept

Definition at line 111 of file journal_codec.hpp.

References pineforge::detail::corrupt, pineforge::detail::ok, position, remaining(), and status.

Referenced by text().

word()

std::uint64_t pineforge::detail::journal_codec::Reader::word ( )

inlinenoexcept

Definition at line 116 of file journal_codec.hpp.

References bytes(), and pineforge::detail::value.

Referenced by integer(), real(), and text().

presence()

bool pineforge::detail::journal_codec::Reader::presence ( )

inlinenoexcept

Definition at line 124 of file journal_codec.hpp.

References bytes(), pineforge::detail::corrupt, status, and pineforge::detail::value.

integer()

template<class T>

void pineforge::detail::journal_codec::Reader::integer ( T & out )

inlinenoexcept

Definition at line 131 of file journal_codec.hpp.

References pineforge::detail::corrupt, status, pineforge::detail::value, and word().

real()

void pineforge::detail::journal_codec::Reader::real ( double & out )

inlinenoexcept

Definition at line 151 of file journal_codec.hpp.

References pineforge::detail::value, and word().

text()

void pineforge::detail::journal_codec::Reader::text ( std::string & out, bool owning )

inline

Definition at line 155 of file journal_codec.hpp.

References bytes(), pineforge::detail::corrupt, pineforge::detail::ok, remaining(), skip(), status, and word().

finish()

ScratchStatus pineforge::detail::journal_codec::Reader::finish ( ) const

inlinenoexcept

Definition at line 166 of file journal_codec.hpp.

References pineforge::detail::corrupt, pineforge::detail::ok, position, source, and status.

Field Documentation

source

const ScratchByteSource& pineforge::detail::journal_codec::Reader::source

Definition at line 76 of file journal_codec.hpp.

Referenced by bytes(), finish(), and remaining().

page

ScratchBuffer pineforge::detail::journal_codec::Reader::page

Definition at line 77 of file journal_codec.hpp.

Referenced by bytes().

position

std::uint64_t pineforge::detail::journal_codec::Reader::position = 0

Definition at line 78 of file journal_codec.hpp.

Referenced by bytes(), finish(), remaining(), and skip().

status

ScratchStatus pineforge::detail::journal_codec::Reader::status = ScratchStatus::ok

Definition at line 79 of file journal_codec.hpp.

Referenced by bytes(), finish(), integer(), presence(), skip(), and text().

cached_at

std::uint64_t pineforge::detail::journal_codec::Reader::cached_at = 0

Definition at line 80 of file journal_codec.hpp.

Referenced by bytes().

cached_size

std::size_t pineforge::detail::journal_codec::Reader::cached_size = 0

Definition at line 81 of file journal_codec.hpp.

Referenced by bytes().

---

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

• journal_codec.hpp