Skip to main content

PublishedSnapshot

Struct PublishedSnapshot 

Source
pub struct PublishedSnapshot { /* private fields */ }
Expand description

Single-writer multi-reader cell holding the current DocumentSnapshot. The actor stores; everyone else loads.

Backed by arc_swap::ArcSwap, an RCU-flavored primitive: load is wait-free (~2ns), store is a single atomic release-store; reclamation is by refcount drop on the last Arc<DocumentSnapshot> reader. Per DESIGN.md §5.6.8 these semantics are not fungible – the renderer’s correctness model depends on them.

Implementations§

Source§

impl PublishedSnapshot

Source

pub fn new(initial: DocumentSnapshot) -> Self

M.2.b.1 (2026-05-31): promoted from pub(crate) so external Document impls (MultibufferDocumentHandle in lattice-multibuffer, future plugin-defined kinds) can publish their own composed snapshots. The publish discipline still applies — every impl is responsible for “publish-after-mutate” ordering against its own readers. The actor model in this crate enforces that discipline through the message loop; multibuffer enforces it through its own internal serialisation.

Source

pub fn cell_arc(&self) -> Arc<ArcSwap<DocumentSnapshot>> ⓘ

Borrowed handle to the shared Arc<ArcSwap<...>>. Used by SnapshotCache::new to share the underlying cell with a per-thread reader cache. Promoted from pub(crate) for the same reason as Self::new — external impls need to hand the cell to SnapshotCache::new for their own snapshot_cache() trait method.

Source

pub fn load(&self) -> Arc<DocumentSnapshot> ⓘ

Wait-free read. Returns an Arc<DocumentSnapshot> that lives as long as the caller needs it. Renderers call this once per visible document per frame.

Source

pub fn store(&self, next: DocumentSnapshot)

Replace the published snapshot with next. Atomic; any reader that observes the new pointer also observes all writes the publisher ordered before the store. Promoted from pub(crate) so external Document impls publish their own snapshots; the actor model in this crate is no longer the only writer.

Trait Implementations§

Source§

impl Debug for PublishedSnapshot

Source§

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

Formats the value using the given formatter. 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

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