Skip to main content

SqliteObjsVfs

Struct SqliteObjsVfs 

Source
pub struct SqliteObjsVfs;
Expand description

Handle to the sqlite-objs VFS.

The VFS is registered globally and persists for the lifetime of the process. This is a zero-sized type that provides static methods for VFS registration.

Implementations§

Source§

impl SqliteObjsVfs

Source

pub fn register(make_default: bool) -> Result<()>

Register the sqlite-objs VFS using environment variables.

Reads configuration from:

  • AZURE_STORAGE_ACCOUNT
  • AZURE_STORAGE_CONTAINER
  • AZURE_STORAGE_SAS (checked first)
  • AZURE_STORAGE_KEY (fallback)
§Arguments
  • make_default - If true, sqlite-objs becomes the default VFS for all connections
§Errors

Returns an error if registration fails (e.g., missing environment variables).

Source

pub fn register_with_config( config: &SqliteObjsConfig, make_default: bool, ) -> Result<()>

Register the sqlite-objs VFS with explicit configuration.

§Arguments
  • config - Azure Storage configuration
  • make_default - If true, sqlite-objs becomes the default VFS for all connections
§Errors

Returns an error if the configuration contains invalid data (null bytes) or if registration fails.

Source

pub fn register_uri(make_default: bool) -> Result<()>

Register the sqlite-objs VFS in URI mode.

In this mode, Azure credentials must be provided via URI parameters for each database:

file:mydb.db?azure_account=acct&azure_container=cont&azure_sas=token

Supported URI parameters:

  • azure_account (required)
  • azure_container
  • azure_sas
  • azure_key
  • azure_endpoint
§Arguments
  • make_default - If true, sqlite-objs becomes the default VFS for all connections
§Errors

Returns an error if registration fails.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.