Struct ConnectionBuilder

pub struct ConnectionBuilder { /* private fields */ }

Implementations

impl ConnectionBuilder

pub fn new() -> Self

Configure and build a new Connection.

pub fn thread_builder(self, thread: Builder) -> Self

Configure the thread that the database connection will live on.

pub fn channel_size(self, size: usize) -> Self

Configure how many functions can be queued to run on our connection before conn.call(..).await will wait and backpressure will kick in.

pub fn on_close<F: FnOnce(Option<Connection>) + Send + 'static>( self, f: F, ) -> Self

Configure a function to be called exactly once when the connection is closed. If the database has already been closed then it will be given None, else it will be handed the database connection.

pub async fn open<P: AsRef<Path>>(self, path: P) -> Result<Connection, Error>

Open a new connection to an SQLite database. If a database does not exist at the path, one is created.

Failure

Will return Err if path cannot be converted to a C-compatible string or if the underlying SQLite open call fails.

pub async fn open_in_memory(self) -> Result<Connection, Error>

Open a new connection to an in-memory SQLite database.

Failure

Will return Err if the underlying SQLite open call fails.

pub async fn open_with_flags<P: AsRef<Path>>( self, path: P, flags: OpenFlags, ) -> Result<Connection, Error>

Open a new connection to a SQLite database.

Database Connection for a description of valid flag combinations.

Failure

Will return Err if path cannot be converted to a C-compatible string or if the underlying SQLite open call fails.

pub async fn open_with_flags_and_vfs<P: AsRef<Path>>( self, path: P, flags: OpenFlags, vfs: &str, ) -> Result<Connection, Error>

Open a new connection to a SQLite database using the specific flags and vfs name.

Database Connection for a description of valid flag combinations.

Failure

Will return Err if either path or vfs cannot be converted to a C-compatible string or if the underlying SQLite open call fails.

pub async fn open_in_memory_with_flags( self, flags: OpenFlags, ) -> Result<Connection, Error>

Open a new connection to an in-memory SQLite database.

Database Connection for a description of valid flag combinations.

Failure

Will return Err if the underlying SQLite open call fails.

pub async fn open_in_memory_with_flags_and_vfs( self, flags: OpenFlags, vfs: &str, ) -> Result<Connection, Error>

Open a new connection to an in-memory SQLite database using the specific flags and vfs name.

Database Connection for a description of valid flag combinations.

Failure

Will return Err if vfs cannot be converted to a C-compatible string or if the underlying SQLite open call fails.

Trait Implementations

impl Default for ConnectionBuilder

fn default() -> Self

Returns the “default value” for a type.