Struct sudoku_backend::ops::setup::DatabaseConnection

pub struct DatabaseConnection(_);

Connection request guard type: a wrapper around an r2d2 pooled connection.

Use this as an argument to a Rocket request handler after having it manage()d to gain access to the database.

Examples

#[get("/databased")]
fn databased(db: DatabaseConnection) -> String {
    // Do some database ops, which are outside the scope of this document
    funxion_result
}

fn main() {
    let database_file: (String, PathBuf) = /* obtained elsewhere */;
    rocket::ignite()
        .manage(DatabaseConnection::initialise(&database_file))
        .mount("/", routes![databased])
        .launch();
}

Methods

impl DatabaseConnection

pub fn initialise(     db_file: &(String, PathBuf) ) -> Pool<ConnectionManager<SqliteConnection>>

Set up a connection to the main database located in the specified file and initialise it with util::INITIALISE_DATABASE.

Methods from Deref<Target = SqliteConnection>

pub fn immediate_transaction<T, E, F>(&self, f: F) -> Result<T, E> where     E: From<Error>,     F: FnOnce() -> Result<T, E>,

Run a transaction with BEGIN IMMEDIATE

This method will return an error if a transaction is already open.

Example

conn.immediate_transaction(|| {
    // Do stuff in a transaction
    Ok(())
})

pub fn exclusive_transaction<T, E, F>(&self, f: F) -> Result<T, E> where     E: From<Error>,     F: FnOnce() -> Result<T, E>,

Run a transaction with BEGIN EXCLUSIVE

This method will return an error if a transaction is already open.

Example

conn.exclusive_transaction(|| {
    // Do stuff in a transaction
    Ok(())
})

Trait Implementations

impl Deref for DatabaseConnection

type Target = SqliteConnection

The resulting type after dereferencing.

fn deref(&self) -> &SqliteConnection

Dereferences the value.

impl<'a, 'r> FromRequest<'a, 'r> for DatabaseConnection

Attempts to retrieve a single connection from the managed database pool.

If no pool is currently managed, fails with an InternalServerError status. If no connections are available, fails with a ServiceUnavailable status.

type Error = ()

The associated error to be returned if derivation fails.

fn from_request(     request: &'a Request<'r> ) -> RequestOutcome<DatabaseConnection, ()>

Derives an instance of Self from the incoming request metadata.