Struct axum_sqlx_tx::Layer

pub struct Layer<DB: Database, E = Error> { /* private fields */ }

A tower_layer::Layer that enables the Tx extractor.

This layer adds a lazily-initialised transaction to the request extensions. The first time the Tx extractor is used on a request, a connection is acquired from the configured [sqlx::Pool] and a transaction is started on it. The same transaction will be returned for subsequent uses of Tx on the same request. The inner service is then called as normal. Once the inner service responds, the transaction is committed or rolled back depending on the status code of the response.

Implementations

impl<DB: Database> Layer<DB>

pub fn new(pool: Pool<DB>) -> Self

Construct a new layer with the given pool.

A connection will be obtained from the pool the first time a Tx is extracted from a request.

If you want to access the pool outside of a transaction, you should add it also with axum::Extension.

To use a different type than Error to convert commit errors into responses, see new_with_error.

pub fn new_with_error<E>(pool: Pool<DB>) -> Layer<DB, E>

Construct a new layer with a specific error type.

See Layer::new for more information.

Trait Implementations

impl<DB: Database, E> Clone for Layer<DB, E>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<DB: Database, S, E> Layer<S> for Layer<DB, E>

type Service = Service<DB, S, E>

The wrapped service

fn layer(&self, inner: S) -> Self::Service

Wrap the given service with the middleware, returning a new service that has been decorated with the middleware.