SQLite VFS Shim
Single header with classes for easily implementing SQLite VFS shims in C++11
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | List of all members
sqlitevfs::SQLiteFile< TFileImpl > Struct Template Reference

#include <SQLiteVfs.hpp>

Inheritance diagram for sqlitevfs::SQLiteFile< TFileImpl >:

Public Types

using FileImpl = TFileImpl
 

Public Member Functions

void setup (int open_result)
 

Public Attributes

sqlite3_io_methods methods
 
FileImpl implementation
 
sqlite3_file original_file [0]
 

Detailed Description

template<typename TFileImpl>
struct sqlitevfs::SQLiteFile< TFileImpl >

POD sqlite3_file subclass that forwards all invocations to an embedded object that inherits SQLiteFileImpl.

You should not create objects of this type manually nor subclass it.

Template Parameters
TFileImplSQLiteFileImpl subclass

Member Typedef Documentation

◆ FileImpl

template<typename TFileImpl >
using sqlitevfs::SQLiteFile< TFileImpl >::FileImpl = TFileImpl

Member Function Documentation

◆ setup()

template<typename TFileImpl >
void sqlitevfs::SQLiteFile< TFileImpl >::setup ( int  open_result)
inline

Setup internal state based on the open_result flag.

This function is called automatically by SQLiteVfs::wrap_xOpen. If open_result is SQLITE_OK, pMethods will be populated. Otherwise, pMethods will be set to NULL and SQLite won't call them.

Parameters
open_resultA SQLite error code. Pass SQLITE_OK to fully setup the file object. Pass anything else to set pMethods to NULL.

Member Data Documentation

◆ implementation

template<typename TFileImpl >
FileImpl sqlitevfs::SQLiteFile< TFileImpl >::implementation

File implementation object of the SQLiteFileImpl subclass passed as template parameter to SQLiteVfsImpl<>.

◆ methods

template<typename TFileImpl >
sqlite3_io_methods sqlitevfs::SQLiteFile< TFileImpl >::methods

SQLite IO methods populated by SQLiteFile::setup.

◆ original_file

template<typename TFileImpl >
sqlite3_file sqlitevfs::SQLiteFile< TFileImpl >::original_file[0]

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