Development Documentation (main branch) - For stable release docs, see docs.rs/eidetica
Skip to main content

DatabaseOp

Enum DatabaseOp 

Source
pub enum DatabaseOp {
    BeginTransaction {
        stores: Vec<String>,
        scope: ReadScope,
    },
    SubmitSignedEntry {
        entry: Box<Entry>,
    },
    GetVerifiedTips,
    GetStoreState {
        store: String,
    },
    GetStoreEntries {
        store: String,
        tips: Vec<ID>,
        scope: ReadScope,
    },
    GetStoreTipsUpToEntries {
        store: String,
        up_to: Vec<ID>,
    },
    ComputeMergeState {
        store: String,
        entry_ids: Vec<ID>,
    },
    GetEntry {
        id: ID,
    },
    GetCachedCrdtState {
        store: String,
        key: ID,
    },
    CacheCrdtState {
        store: String,
        key: ID,
        blob: Vec<u8>,
    },
    SetInstanceMetadata {
        metadata: Box<InstanceMetadata>,
    },
}
Expand description

Database-level operations the server runs on its local Database.

The target database (root_id) and identity claim travel in AuthenticatedDbRequest; the per-tree gate runs against root_id (Read for begin/get*, Write for submit, Admin-on-_databases for set-metadata) before dispatch.

Variants§

§

BeginTransaction

Acquire everything needed to build+sign a transaction locally for the given stores, with parents drawn from scope’s projection. Gate Read.

Fields

§stores: Vec<String>
§

SubmitSignedEntry

Submit a finished, client-signed entry. The server stores it Unverified and runs its own verification pass — it never trusts a submitted entry’s claimed validity. Submit is verification-gated, not session-gated: it requires only an authenticated connection, and the per-tree permission gate is not applied (the server’s verification pass against the tree’s pinned auth is the boundary). The required_permission() value below is advisory only for this variant.

Fields

§entry: Box<Entry>
§

GetVerifiedTips

The database’s Verified-frontier tips (server runs Database::snapshot on its local instance). Gate Read.

§

GetStoreState

Server-materialized merged state of an unencrypted store, against the server’s own Verified frontier. Gate Read.

Fields

§store: String
§

GetStoreEntries

Ordered (by subtree height), verified, opaque store entries reachable from tips in scope — the universal primitive, incl. encrypted stores (client decrypts+merges locally). Gate Read.

Fields

§store: String
§tips: Vec<ID>
§

GetStoreTipsUpToEntries

Subtree tips reachable from given main-tree entry IDs. Used by Transaction internals to discover store entries.

Fields

§store: String
§up_to: Vec<ID>
§

ComputeMergeState

Lowest common ancestor + path to tip entries in a store DAG. Fused to one RPC: the only caller always calls find_merge_base then get_path_from_to in sequence.

Fields

§store: String
§entry_ids: Vec<ID>
§

GetEntry

Fetch a single entry by id (gated post-fetch by its owning tree). Gate Read.

Fields

§id: ID
§

GetCachedCrdtState

Look up a cached materialized CRDT state. Server returns the previously CacheCrdtState-submitted blob for (session user, root_id, key, store), or None on miss. Gate Read.

Used by RemoteBackend::get_cached_crdt_state as the second tier of a two-level cache: the client first checks its own per-connection LRU, then falls back to this RPC. The daemon’s cache is the cross-session source of truth.

Fields

§store: String
§key: ID
§

CacheCrdtState

Stash a client-computed materialized CRDT state for (session user, root_id, key, store). Gate Read.

Per-user trust model: the daemon stores whatever bytes the authenticated user sends, scoped to their user_uuid. The blob is opaque to the daemon — ciphertext for encrypted stores, plaintext for plain ones — and the daemon performs no verification of the merge result. The trust boundary is the same one the client would have with a local-only cache: only the submitting user can poison their future reads on this slot.

Tip-based natural expiry: keys are derived from tip sets (see create_merge_cache_id), so an entry whose tip set has advanced is simply unreachable — future reads miss against a fresh key. Stale entries fall out of the LRU under memory pressure rather than via explicit invalidation.

Fields

§store: String
§key: ID
§blob: Vec<u8>
§

SetInstanceMetadata

Rewrite the daemon’s instance metadata (system-DB pointers). Gated by Admin on _databases (a daemon-global system tree, resolved server-side — not the request’s root_id), so the per-tree gate is special-cased for this variant in the dispatcher. Boxed to keep the enum’s stack footprint small — InstanceMetadata dominates its size.

Fields

Implementations§

Source§

impl DatabaseOp

Source

pub fn required_permission(&self) -> Permission

Minimum permission the caller needs against the target database.

Only SubmitSignedEntry mutates; everything else is a read. Every read variant is tree-scoped via the request’s root_id, so the per-tree gate always runs for reads — there is no tree-less fall-through. SubmitSignedEntry is the exception: the server skips the per-tree gate for submit and relies on its own verification pass, so the Write(0) returned here is advisory only for that variant (kept for completeness / non-submit callers that inspect it).

Trait Implementations§

Source§

impl Clone for DatabaseOp

Source§

fn clone(&self) -> DatabaseOp

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 DatabaseOp

Source§

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

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

impl<'de> Deserialize<'de> for DatabaseOp

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 Serialize for DatabaseOp

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

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
§

impl<T> CompatExt for T

§

fn compat(self) -> Compat<T>

Applies the [Compat] adapter by value. Read more
§

fn compat_ref(&self) -> Compat<&T>

Applies the [Compat] adapter by shared reference. Read more
§

fn compat_mut(&mut self) -> Compat<&mut T>

Applies the [Compat] adapter by mutable reference. Read more
Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

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