Skip to main content

QueryIsolation

Enum QueryIsolation 

Source
pub enum QueryIsolation {
    ReadUncommitted,
    ReadCommitted {
        wait_for: Vec<ConsensusId>,
    },
    Snapshot {
        prestate_hash: Hash32,
    },
    ReadLatest {
        scope: ResourceScope,
    },
}
Expand description

Query isolation levels for consistency requirements.

Aura’s journal is eventually consistent via CRDT merge. These isolation levels let queries specify their consistency requirements:

  • ReadUncommitted: See latest CRDT state (fastest, may see uncommitted facts)
  • ReadCommitted: Only see facts confirmed by consensus
  • Snapshot: Query against a specific historical prestate
  • ReadLatest: Wait for all pending consensus in scope to complete

§Example

// Fast query - may see uncommitted facts
let result = effects.query_with_isolation(
    &ChannelsQuery::default(),
    QueryIsolation::ReadUncommitted,
).await?;

// Strong consistency - wait for specific consensus
let result = effects.query_with_isolation(
    &ChannelsQuery::default(),
    QueryIsolation::ReadCommitted { wait_for: vec![consensus_id] },
).await?;

Variants§

§

ReadUncommitted

See all facts including uncommitted (CRDT state).

Fastest option - queries execute immediately against the current CRDT state without waiting for consensus confirmation.

§

ReadCommitted

Only see facts with consensus commit.

Waits for specified consensus instances to complete before executing the query. Use this when you need to see the results of specific operations that required consensus.

Fields

§wait_for: Vec<ConsensusId>

Consensus instances to wait for before executing query

§

Snapshot

Snapshot at specific prestate (time-travel query).

Queries against a historical state identified by its prestate hash. Useful for auditing or debugging. The prestate must still be available (not garbage collected).

Fields

§prestate_hash: Hash32

Hash of the prestate to query against

§

ReadLatest

Wait for all pending consensus in scope to complete.

More expensive than ReadCommitted - waits for all pending consensus operations that affect the specified resource scope. Use sparingly.

Note: This is NOT linearizable - just ensures all pending commits are visible at query time.

Fields

§scope: ResourceScope

Resource scope to wait for

Implementations§

Source§

impl QueryIsolation

Source

pub fn read_committed(consensus_id: ConsensusId) -> Self

Create a ReadCommitted isolation waiting for a single consensus

Source

pub fn snapshot(prestate_hash: Hash32) -> Self

Create a Snapshot isolation for a specific prestate

Source

pub fn read_latest(scope: ResourceScope) -> Self

Create a ReadLatest isolation for a resource scope

Source

pub fn requires_wait(&self) -> bool

Check if this isolation level requires waiting

Trait Implementations§

Source§

impl Clone for QueryIsolation

Source§

fn clone(&self) -> QueryIsolation

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 QueryIsolation

Source§

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

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

impl Default for QueryIsolation

Source§

fn default() -> QueryIsolation

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for QueryIsolation

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for QueryIsolation

Source§

fn eq(&self, other: &QueryIsolation) -> 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 Serialize for QueryIsolation

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for QueryIsolation

Source§

impl StructuralPartialEq for QueryIsolation

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<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<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<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> 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<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more
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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,