boost_sqlite 1
A sqlite C++ library
Loading...
Searching...
No Matches
boost::sqlite::value Struct Reference

A holder for a sqlite values used for internal APIs. More...

#include <include/boost/sqlite/value.hpp>

Public Types

using handle_type = sqlite3_value *
 The handle of the value.
 

Public Member Functions

 value (sqlite3_value *value_) noexcept
 Construct value from a handle.
 
bool from_bind () const
 True if value originated from a bound parameter.
 
blob_view get_blob () const
 Returns the value as blob, i.e. raw memory. Note that this value may be invalidated`.
 
double get_double () const
 Returns the value as an double.
 
int get_int () const
 Returns the value as regular int.
 
sqlite3_int64 get_int64 () const
 Returns the value as an int64.
 
template<typename T >
T * get_pointer ()
 
cstring_ref get_text () const
 Returns the value as text, i.e. a string_view. Note that this value may be invalidated`.
 
handle_type handle () const
 Returns the handle.
 
bool is_null () const
 Is the held value null.
 
bool nochange () const
 True if the column is unchanged in an UPDATE against a virtual table.
 
value_type numeric_type () const
 Best numeric datatype of the value.
 
 operator bool () const
 Is the held value is not null.
 
int subtype () const
 The subtype of the value, see.
 
value_type type () const
 The type of the value.
 

Detailed Description

A holder for a sqlite values used for internal APIs.

Definition at line 38 of file value.hpp.

Member Function Documentation

◆ get_pointer()

template<typename T >
T * boost::sqlite::value::get_pointer ( )
inline

Get a value that was passed through the pointer interface. A value can be set as a pointer by binding/returning a unique_ptr.

Definition at line 107 of file value.hpp.


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