FastMM documentation
FastMM C++ API 0.6.0
Public headers, tier 1 and tier 2
Loading...
Searching...
No Matches
fastmm::store Namespace Reference

Classes

class  Backend
 
struct  BackendOptions
 What a backend is built with. More...
 
struct  BookedFillQuery
 The executions an engine stored for one venue (Reader::booked_fills): the engine's side of a fill audit (core/fill_audit.hpp). More...
 
struct  ParamQuery
 Every query takes the same filter; a backend ignores the fields its query has no use for. More...
 
struct  QueryFilter
 
class  Reader
 
struct  Recovery
 What the previous session left behind, for the operator who is about to start a new one. More...
 
struct  Rows
 
struct  SessionClose
 Written once, after the last record. More...
 
struct  SessionOpen
 Written once, before any record. More...
 
struct  StoreEntry
 
class  StoreRegistry
 
class  StoreThread
 
struct  StoreThreadOptions
 
struct  StoreThreadStats
 

Enumerations

enum class  AddResult : std::uint8_t { Added , AlreadyPresent , Conflict , Invalid }
 

Functions

constexpr std::string_view to_string (AddResult r) noexcept
 
void register_builtin_backends (StoreRegistry &r=StoreRegistry::instance())
 Adds the backends FastMM ships ("sqlite"). Idempotent.
 
std::string configured_backend (const GenericSection &storage)
 [storage] backend, defaulting to "sqlite"; "none" disables the store.
 
std::unique_ptr< Backend > make_sqlite_backend ()
 
std::unique_ptr< Reader > make_sqlite_reader ()
 
std::string sqlite_path (const BackendOptions &opts)
 Where the backend puts its file: [storage] path, else "\<default_dir\>/\<engine_name\>.db".
 

Variables

constexpr std::string_view kNoBackend = "none"
 
constexpr int kSqliteSchemaVersion = 9
 Bumped whenever the schema changes; sqlite_schema.cpp holds one migration step per version.
 

Enumeration Type Documentation

◆ AddResult

enum class fastmm::store::AddResult : std::uint8_t
strong
Enumerator
Added 
AlreadyPresent 
Conflict 
Invalid 

Function Documentation

◆ to_string()

constexpr std::string_view fastmm::store::to_string ( AddResult  r)
constexprnoexcept

◆ register_builtin_backends()

void fastmm::store::register_builtin_backends ( StoreRegistry &  r = StoreRegistry::instance())

Adds the backends FastMM ships ("sqlite"). Idempotent.

◆ configured_backend()

std::string fastmm::store::configured_backend ( const GenericSection &  storage)

[storage] backend, defaulting to "sqlite"; "none" disables the store.

◆ make_sqlite_backend()

std::unique_ptr< Backend > fastmm::store::make_sqlite_backend ( )

◆ make_sqlite_reader()

std::unique_ptr< Reader > fastmm::store::make_sqlite_reader ( )

◆ sqlite_path()

std::string fastmm::store::sqlite_path ( const BackendOptions &  opts)

Where the backend puts its file: [storage] path, else "\<default_dir\>/\<engine_name\>.db".

Variable Documentation

◆ kNoBackend

constexpr std::string_view fastmm::store::kNoBackend = "none"
inlineconstexpr

◆ kSqliteSchemaVersion

constexpr int fastmm::store::kSqliteSchemaVersion = 9
inlineconstexpr

Bumped whenever the schema changes; sqlite_schema.cpp holds one migration step per version.