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

Notification

Enum Notification 

Source
pub enum Notification {
    DatabaseWrite {
        root_id: ID,
        previous_tips: Snapshot,
        post_tips: Snapshot,
        source: WriteSource,
    },
}
Expand description

Server-initiated push to the client, interleaved with normal responses at any point after a connection has authenticated.

Notifications are not solicited by a specific request; the client signs up for them with a DatabaseOp::SubscribeWrites and unsubscribes by dropping the connection or sending DatabaseOp::UnsubscribeWrites.

Notifications are triggered only by settled-state writes — i.e. entries that have passed local verification on the daemon. An entry that arrives Unverified (via sync, or as a SubmitSignedEntry body) is ingested silently and only produces a notification once the daemon’s verification pass promotes it to Verified.

This does not mean the bracket contains only Verified entries. The cursors are raw DAG frontiers (Backend::snapshot), not the Verified frontier, so an Unverified or Failed entry sitting as a raw tip falls inside every subsequent bracket and Database::ids_added will enumerate it. A subscriber that expands a bracket and fetches the IDs can therefore observe entries that failed the daemon’s auth settings. Consumers that care must filter on verification status themselves; locally that is Backend::get_verification_status, and over the wire there is currently no way to do it at all — treat bracket-derived IDs as untrusted until read back through a gated path.

A second consequence of the raw-frontier cursor: because it advances past a still-Unverified tip, a later verify() that promotes that entry fires with previous_tips == post_tips for the subscriber, so ids_added returns empty and the promotion is never signalled. An entry can be reported once while untrusted and never mentioned again.

The frame carries cursor brackets only — no entry payloads, no entry IDs. Subscribers that need to enumerate the new entries expand the brackets locally via Database::ids_added. This decision has two consequences:

  1. Security: per-tree Read is gated once at SubscribeWrites; the publisher fan-out does not re-check on each event. Shipping cursors only means a subscriber whose permission is revoked mid-session can at most learn that some write happened on the tree — never the contents of those writes, which would only reach the client through an explicit, currently-gated read.
  2. Efficiency: sync ingest can batch many entries; a cursor pair is constant-size regardless of batch width.

Variants§

§

DatabaseWrite

A settled-state write landed on the daemon for root_id.

  • previous_tips is the daemon-side subscription cursor at the moment of this fire — i.e. the previous_tips of the event the daemon dispatched to this subscription’s callback. Useful for thin-forwarder topologies and trace/debug.
  • post_tips is the daemon’s tips after this write. The client uses it to advance every local per-callback cursor for this tree — each local callback’s next event will have previous_tips = post_tips (the cursor moves forward by exactly one event).
  • source distinguishes local-vs-sync for consumers that want to branch.

Fields

§root_id: ID
§previous_tips: Snapshot
§post_tips: Snapshot

Trait Implementations§

Source§

impl Clone for Notification

Source§

fn clone(&self) -> Notification

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 Notification

Source§

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

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

impl<'de> Deserialize<'de> for Notification

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 Notification

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

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

§

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

Source§

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

§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,