From 57d1562bf8d1688c1ef02064884536f6bc5e368f Mon Sep 17 00:00:00 2001 From: Yuri Astrakhan Date: Tue, 16 Jul 2024 14:24:06 -0400 Subject: [PATCH] Improve loadable extension docs, clippy --- examples/loadable_extension.rs | 30 ++++++++++++++++++------------ 1 file changed, 18 insertions(+), 12 deletions(-) diff --git a/examples/loadable_extension.rs b/examples/loadable_extension.rs index e596ea5..eb0fc1b 100644 --- a/examples/loadable_extension.rs +++ b/examples/loadable_extension.rs @@ -1,4 +1,18 @@ //! Adaptation of https://sqlite.org/loadext.html#programming_loadable_extensions +//! +//! # build +//! ```sh +//! cargo build --example loadable_extension --features "loadable_extension functions trace" +//! ``` +//! +//! # test +//! ```sh +//! sqlite> .log on +//! sqlite> .load target/debug/examples/libloadable_extension.so +//! (28) Rusqlite extension initialized +//! sqlite> SELECT rusqlite_test_function(); +//! Rusqlite extension loaded correctly! +//! ``` use std::os::raw::{c_char, c_int}; use rusqlite::ffi; @@ -6,18 +20,10 @@ use rusqlite::functions::FunctionFlags; use rusqlite::types::{ToSqlOutput, Value}; use rusqlite::{Connection, Result}; -/// # build -/// ```sh -/// cargo build --example loadable_extension --features "loadable_extension functions trace" -/// ``` -/// # test -/// ```sh -/// sqlite> .log on -/// sqlite> .load target/debug/examples/libloadable_extension.so -/// (28) Rusqlite extension initialized -/// sqlite> SELECT rusqlite_test_function(); -/// Rusqlite extension loaded correctly! -/// ``` +/// Entry point for SQLite to load the extension. +/// See on this function's name and usage. +/// # Safety +/// This function is called by SQLite and must be safe to call. #[expect(clippy::not_unsafe_ptr_arg_deref)] #[no_mangle] pub unsafe extern "C" fn sqlite3_extension_init(