Skip to main content

UpsertOutcome

Enum UpsertOutcome 

Source
pub enum UpsertOutcome<M> {
    Inserted(M),
    Existing(M),
}
Expand description

Outcome of a .upsert(..).do_nothing().run(..) call.

§Race semantics

The runtime always resolves the conflict under a SELECT ... FOR UPDATE row lock held for the lifetime of the surrounding transaction (see upsert_do_nothing_exec::run_upsert_do_nothing_in_tx for the exact sequencing):

  • If the probe finds an existing row, that row is locked before this call returns — no concurrent transaction can delete or modify it until the caller commits — so Existing is a guarantee about the row’s state at the moment this call returns, not merely “at some point during the call”.
  • If the probe finds nothing, the actual INSERT ... ON CONFLICT DO NOTHING is still the statement that runs (not a plain INSERT), because the probe’s “no row” answer does not itself lock anything — a concurrent transaction can commit a conflicting row in the gap between the probe and the INSERT. When that race is lost, the runtime performs one more locked read to hand back the row the other transaction actually committed, so callers never see a phantom “existing” row invented from stale data — see Existing below for what happens if that row is deleted before the fallback read completes.

Variants§

§

Inserted(M)

This call performed the insert. No row previously existed at the conflict target.

§

Existing(M)

A row already existed at the conflict target and was left completely untouched by this call — no columns written, no Updated event emitted, no audit entry recorded, because nothing about the row changed.

If this outcome was reached via the race-fallback path (the insert branch lost a concurrent-insert race and had to read the winning row back), and that row was deleted before the fallback read could complete, the call surfaces CoolError::Conflict instead of ever constructing an Existing from data that might not be current — see upsert_do_nothing_exec for that narrower race.

Implementations§

Source§

impl<M> UpsertOutcome<M>

Source

pub fn was_inserted(&self) -> bool

true for Self::Inserted.

Source

pub fn into_record(self) -> M

Discard the inserted-vs-existing distinction and take the row. Prefer matching on the enum when the distinction matters (that’s the entire reason this type exists) — this is for callers that only ever need the record, e.g. read-modify-report call sites that already branched on Self::was_inserted.

Source

pub fn record(&self) -> &M

Borrow the record regardless of which variant this is.

Trait Implementations§

Source§

impl<M: Clone> Clone for UpsertOutcome<M>

Source§

fn clone(&self) -> UpsertOutcome<M>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<M: Debug> Debug for UpsertOutcome<M>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<M: Eq> Eq for UpsertOutcome<M>

Source§

impl<M: PartialEq> PartialEq for UpsertOutcome<M>

Source§

fn eq(&self, other: &UpsertOutcome<M>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl<M: PartialEq> StructuralPartialEq for UpsertOutcome<M>

Auto Trait Implementations§

§

impl<M> Freeze for UpsertOutcome<M>
where M: Freeze,

§

impl<M> RefUnwindSafe for UpsertOutcome<M>
where M: RefUnwindSafe,

§

impl<M> Send for UpsertOutcome<M>
where M: Send,

§

impl<M> Sync for UpsertOutcome<M>
where M: Sync,

§

impl<M> Unpin for UpsertOutcome<M>
where M: Unpin,

§

impl<M> UnsafeUnpin for UpsertOutcome<M>
where M: UnsafeUnpin,

§

impl<M> UnwindSafe for UpsertOutcome<M>
where M: UnwindSafe,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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