Crate sqlite_loadable

mod level?

Modules

api

(Mostly) safe wrappers around low-level sqlite3 C API.

entrypoints

Utilities for working with SQLite’s “sqlite3_extension_init”-style entrypoints.

errors

Custom Error/Result for sqlite-loadable-rs APIs.

ext

Unsafe wrappers around low-level sqlite3 C API.

prelude

Commonly used sqlite-loadable items for easy glob imports.

scalar

Define scalar functions on sqlite3 database connections.

table

Defining virtual tables and table functions on sqlite3 database connections.

vtab_argparse

Opininated parsing for SQLite virtual table constructor arguments.

Structs

Error

Any error that occurs while creating or using a SQLite extension.

FunctionFlags

Represents the possible flag values that can be passed into sqlite3_create_function_v2 or sqlite3_create_window_function, as the 4th “eTextRep” parameter. Includes both the encoding options (utf8, utf16, etc.) and function-level parameters (deterministion, innocuous, etc.).

Enums

BestIndexError

Possible errors to return in xBestIndex.

ErrorKind

The specific type of an error.

Functions

define_scalar_function

Defines a new scalar function on the given database connection.

define_scalar_function_with_aux

Defines a new scalar function, but with the added ability to pass in an arbritary application “pointer” as any rust type. Can be accessed in the callback function as the 3rd argument, as a reference. https://www.sqlite.org/c3ref/create_function.html#:~:text=The%20fifth%20parameter%20is%20an%20arbitrary%20pointer.

define_table_function

Define a table function on the given sqlite3 database. “Table function” is the same as “eponymous-only” virtual table described at https://www.sqlite.org/vtab.html#eponymous_only_virtual_tables

define_virtual_table

Define a virtual table on the sqlite3 database connection. Optionally pass in an auxillary object, which

define_virtual_table_writeable

define_virtual_table_writeablex

Type Definitions

Result

A type alias for Result<T, xxx::Error>.