Skip to main content

PrepareOutcome

Enum PrepareOutcome 

Source
#[non_exhaustive]
pub enum PrepareOutcome { NoOp, Applied { description: String, }, }
Expand description

Outcome of an EngineBackend::prepare call — one-time backend-specific boot preparation.

Issue #281: moves cairn’s ensure_library retry loop upstream so consumers can boot any backend uniformly via backend.prepare().await? without knowing whether it is Valkey (FUNCTION LOAD) or Postgres (migrations are out-of-band per RFC-v0.7 Wave 0 Q12, so NoOp). #[non_exhaustive] so future backends can add variants (e.g. Skipped { reason }) additively.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

NoOp

Backend had nothing to do — either genuinely no-op (Postgres: migrations applied out-of-band) or the requested prep work was already in place and idempotent (Valkey: library already at the expected version; the Valkey impl collapses the “already-present” case into Applied to keep one success variant — consumers that want to distinguish can parse description).

§

Applied

Backend ran preparation work (e.g. Valkey FUNCTION LOAD REPLACE). description is a human-readable summary suitable for info!-level log lines like "FUNCTION LOAD (flowfabric lib v<N>)"; shape is not machine-parseable and MAY change across versions.

Fields

§description: String

Human-readable summary of what was prepared.

Implementations§

Source§

impl PrepareOutcome

Source

pub fn applied(description: impl Into<String>) -> Self

Shorthand constructor for the Applied variant.

Trait Implementations§

Source§

impl Clone for PrepareOutcome

Source§

fn clone(&self) -> PrepareOutcome

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PrepareOutcome

Source§

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

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

impl PartialEq for PrepareOutcome

Source§

fn eq(&self, other: &PrepareOutcome) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for PrepareOutcome

Source§

impl StructuralPartialEq for PrepareOutcome

Auto Trait Implementations§

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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.