Struct ConnectionEnv 

pub struct ConnectionEnv { /* private fields */ }

Connection-scoped environment for selecting the runtime context and tuning resource limits.

Page buffer pool sizing

By default the page-buffer pool is sized via the FSQLITE_PAGE_BUFFER_MAX environment variable (if set), otherwise DEFAULT_PAGE_BUFFER_MAX (262 144 buffers ≈ 1 GiB at 4 KiB pages).

To override programmatically, call set_page_buffer_max before opening a connection:

let mut env = ConnectionEnv::default();
env.set_page_buffer_max(524_288); // 2 GiB at 4 KiB pages
let conn = Connection::open_with_env("big.db", env)?;

Implementations

impl ConnectionEnv

pub fn new(runtime: Arc<RuntimeContext>) -> Self

Create a connection environment from an explicit runtime context.

pub fn set_strict_multi_process(&mut self, strict: bool)

Enable strict multi-process mode for this connection env. With strict mode on, the connection refuses to silently proceed past concurrency contract violations (F_SETLK timeout, freelist trunk page past db_size, WAL checkpoint contention at open) and returns FrankenError::MultiProcessContractViolation instead. See frankensqlite#81.

pub fn strict_multi_process(&self) -> bool

Returns whether strict multi-process refusal is enabled. See frankensqlite#81.

pub fn runtime(&self) -> &Arc<RuntimeContext>

Access the runtime context that will back newly opened connections.

pub fn set_page_buffer_max(&mut self, max_buffers: impl Into<Option<usize>>)

Override the maximum number of page buffers the pager’s buffer pool will allocate.

At the standard 4 KiB page size, each buffer consumes ~4 KiB, so 262_144 ≈ 1 GiB and 524_288 ≈ 2 GiB.

Pass None to revert to the default resolution (env var, then compile-time default).

pub fn page_buffer_max(&self) -> Option<usize>

Returns the explicit page-buffer-pool ceiling, if one has been set.

pub fn set_memory_vfs_config( &mut self, config: impl Into<Option<MemoryVfsConfig>>, )

Override the MemoryVfs growth policy used for :memory: databases and imported SQLite images.

File-backed connections ignore this setting.

pub fn memory_vfs_config(&self) -> Option<MemoryVfsConfig>

Returns the explicit MemoryVfs configuration, if one has been set.

Trait Implementations

impl Clone for ConnectionEnv

fn clone(&self) -> ConnectionEnv

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ConnectionEnv

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ConnectionEnv

fn default() -> Self

Returns the “default value” for a type.