DbOp

Struct DbOp 

Source
pub struct DbOp<'c> { /* private fields */ }
Expand description

Default return type of the derived EsRepo::begin_op().

Used as a wrapper of a sqlx::Transaction but can also cache the time at which the transaction is taking place.

When an artificial clock is provided, the transaction will automatically cache that clock’s time, enabling deterministic testing. This cached time will be used in all time-dependent operations.

Implementations§

Source§

impl<'c> DbOp<'c>

Source

pub async fn init(pool: &PgPool) -> Result<DbOp<'static>, Error>

Initializes a transaction using the global clock.

Delegates to init_with_clock using the global clock handle.

Source

pub async fn init_with_clock( pool: &PgPool, clock: &ClockHandle, ) -> Result<DbOp<'static>, Error>

Initializes a transaction with the specified clock.

If the clock is artificial, its current time will be cached in the transaction.

Source

pub fn with_time(self, time: DateTime<Utc>) -> DbOpWithTime<'c>

Transitions to a DbOpWithTime with the given time cached.

Source

pub fn with_clock_time(self) -> DbOpWithTime<'c>

Transitions to a DbOpWithTime using the clock.

Uses cached time if present, otherwise uses the clock’s current time.

Source

pub async fn with_db_time(self) -> Result<DbOpWithTime<'c>, Error>

Transitions to a DbOpWithTime using the database time.

Priority order:

  1. Cached time if present
  2. Artificial clock time if the clock is artificial
  3. Database time via SELECT NOW()
Source

pub fn maybe_now(&self) -> Option<DateTime<Utc>>

Returns the optionally cached chrono::DateTime

Source

pub async fn begin(&mut self) -> Result<DbOp<'_>, Error>

Begins a nested transaction.

Source

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

Commits the inner transaction.

Source

pub fn tx_mut(&mut self) -> &mut Transaction<'c, Postgres>

Gets a mutable handle to the inner transaction

Trait Implementations§

Source§

impl<'o> AtomicOperation for DbOp<'o>

Source§

fn maybe_now(&self) -> Option<DateTime<Utc>>

Function for querying when the operation is taking place - if it is cached.
Source§

fn clock(&self) -> &ClockHandle

Returns the clock handle for time operations. Read more
Source§

fn as_executor(&mut self) -> &mut PgConnection

Returns the sqlx::Executor implementation. The desired way to represent this would actually be as a GAT: Read more
Source§

fn add_commit_hook<H: CommitHook>(&mut self, hook: H) -> Result<(), H>

Registers a commit hook that will run pre_commit before and post_commit after the transaction commits. Returns Ok(()) if the hook was registered, Err(hook) if hooks are not supported.

Auto Trait Implementations§

§

impl<'c> Freeze for DbOp<'c>

§

impl<'c> !RefUnwindSafe for DbOp<'c>

§

impl<'c> Send for DbOp<'c>

§

impl<'c> !Sync for DbOp<'c>

§

impl<'c> Unpin for DbOp<'c>

§

impl<'c> !UnwindSafe for DbOp<'c>

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<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> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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