Struct Connection

pub struct Connection<D>(/* private fields */)
where
    D: Database;

A request guard which retrieves a single connection to a Database.

For a database type of Db, a request guard of Connection<Db> retrieves a single connection to Db.

The request guard succeeds if the database was initialized by the Initializer fairing and a connection is available within connect_timeout seconds.

• If the Initializer fairing was not attached, the guard fails with status InternalServerError. A Sentinel guards this condition, and so this type of error is unlikely to occur. A None error is returned.
• If a connection is not available within connect_timeout seconds or another error occurs, the guard fails with status ServiceUnavailable and the error is returned in Some.

Deref

A type of Connection<Db> dereferences, mutably and immutably, to the native database connection type. The driver table lists the concrete native Deref types.

Example

use rocket_db_pools::{Database, Connection};

#[derive(Database)]
#[database("db")]
struct Db(Pool);

#[get("/")]
async fn db_op(db: Connection<Db>) {
    // use `&*db` to get an immutable borrow to the native connection type
    // use `&mut *db` to get a mutable borrow to the native connection type
}

Implementations

impl<D> Connection<D>

where D: Database,

pub fn into_inner(self) -> <<D as Database>::Pool as Pool>::Connection

Returns the internal connection value. See the Connection Deref column for the expected type of this value.

Note that Connection<D> derefs to the internal connection type, so using this method is likely unnecessary. See deref for examples.

Example

use rocket_db_pools::{Database, Connection};

#[derive(Database)]
#[database("db")]
struct Db(Pool);

#[get("/")]
async fn db_op(db: Connection<Db>) {
    let inner = db.into_inner();
}

Trait Implementations

impl<D> Deref for Connection<D>

where D: Database,

type Target = <<D as Database>::Pool as Pool>::Connection

The resulting type after dereferencing.

fn deref(&self) -> &<Connection<D> as Deref>::Target

Dereferences the value.

impl<D> DerefMut for Connection<D>

where D: Database,

fn deref_mut(&mut self) -> &mut <Connection<D> as Deref>::Target

Mutably dereferences the value.

impl<'r, D> FromRequest<'r> for Connection<D>

where D: Database,

type Error = Option<<<D as Database>::Pool as Pool>::Error>

The associated error to be returned if derivation fails.

fn from_request<'life0, 'async_trait>( req: &'r Request<'life0>, ) -> Pin<Box<dyn Future<Output = Outcome<Connection<D>, (Status, <Connection<D> as FromRequest<'r>>::Error), Status>> + Send + 'async_trait>>

where 'r: 'async_trait, 'life0: 'async_trait, Connection<D>: 'async_trait,

Derives an instance of Self from the incoming request metadata.

impl<D> Sentinel for Connection<D>

where D: Database,

fn abort(rocket: &Rocket<Ignite>) -> bool

Returns true if launch should be aborted and false otherwise.