Skip to main content

TursoDatabaseConfig

Struct TursoDatabaseConfig 

Source
pub struct TursoDatabaseConfig {
    pub path: String,
    pub experimental_features: Option<String>,
    pub async_io: bool,
    pub encryption: Option<EncryptionOpts>,
    pub vfs: Option<String>,
    pub io: Option<Arc<dyn IO>>,
    pub db_file: Option<Arc<dyn DatabaseStorage>>,
}

Fields§

§path: String

path to the database file or “:memory:” for in-memory connection

§experimental_features: Option<String>

comma-separated list of experimental features to enable this field is intentionally just a string in order to make enablement of experimental features as flexible as possible

§async_io: bool

if true, library methods will return Io status code and delegate Io loop to the caller if false, library will spin IO itself in case of Io status code and never return it to the caller

§encryption: Option<EncryptionOpts>

optional encryption parameters for local data encryption as encryption is experimental - Self::experimental_features must have “encryption” in the list

§vfs: Option<String>

optional VFS parameter explicitly specifying FS backend for the database. Available options are:

  • “memory”: in-memory backend
  • “syscall”: generic syscall backend
  • “io_uring”: IO uring (supported only on Linux)
§io: Option<Arc<dyn IO>>

optional custom IO provided by the caller

§db_file: Option<Arc<dyn DatabaseStorage>>

optional custom DatabaseStorage provided by the caller if provided, caller must guarantee that IO used by the TursoDatabase will be consistent with underlying DatabaseStorage IO

Implementations§

Source§

impl TursoDatabaseConfig

Source

pub fn database_opts(&self) -> DatabaseOpts

Build the typed turso_core::DatabaseOpts from the comma-separated Self::experimental_features string. The feature-name tokens are the SDK/CLI-facing names; unknown names are ignored and "strict" is a no-op (strict tables are always enabled). This keeps the string -> typed-options translation in the SDK layer where the string representation lives, instead of in turso_core.

Source§

impl TursoDatabaseConfig

Source

pub unsafe fn from_capi( config: *const turso_database_config_t, ) -> Result<Self, TursoError>

helper method to restore TursoSetupConfig instance from C representation this method is used in the capi wrappers

§Safety

c::turso_database_config_t::path field must be valid C-string pointer c::turso_database_config_t::experimental_features field must be valid C-string pointer or null

Trait Implementations§

Source§

impl Clone for TursoDatabaseConfig

Source§

fn clone(&self) -> TursoDatabaseConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more