pub struct ArrayInbound<S: StorageEngine> { /* private fields */ }Expand description
Dispatcher for inbound array CRDT wire messages from Origin.
Each handle_* method (defined in sibling modules) is stateless from the
transport layer’s perspective — callers pass the already-decoded wire
message and receive an InboundOutcome.
Snapshot state is buffered internally in snapshots until all chunks for a
given (array, snapshot_hlc) have arrived.
Implementations§
Source§impl<S: StorageEngine> ArrayInbound<S>
impl<S: StorageEngine> ArrayInbound<S>
Sourcepub fn handle_delta(
&self,
msg: &ArrayDeltaMsg,
) -> Result<InboundOutcome, LiteError>
pub fn handle_delta( &self, msg: &ArrayDeltaMsg, ) -> Result<InboundOutcome, LiteError>
Apply a single delta message from Origin.
Decodes the op payload, observes the HLC, then delegates to
nodedb_array::sync::apply::apply_op.
Sourcepub fn handle_delta_batch(
&self,
msg: &ArrayDeltaBatchMsg,
) -> Result<Vec<InboundOutcome>, LiteError>
pub fn handle_delta_batch( &self, msg: &ArrayDeltaBatchMsg, ) -> Result<Vec<InboundOutcome>, LiteError>
Apply a batch of delta messages from Origin.
Returns one InboundOutcome per op payload in the batch.
Source§impl<S: StorageEngine> ArrayInbound<S>
impl<S: StorageEngine> ArrayInbound<S>
Sourcepub fn new(
engine: Arc<LiteApplyEngine<S>>,
schemas: Arc<SchemaRegistry<S>>,
replica: Arc<ReplicaState>,
pending: Arc<PendingQueue<S>>,
catchup: Arc<CatchupTracker<S>>,
) -> Self
pub fn new( engine: Arc<LiteApplyEngine<S>>, schemas: Arc<SchemaRegistry<S>>, replica: Arc<ReplicaState>, pending: Arc<PendingQueue<S>>, catchup: Arc<CatchupTracker<S>>, ) -> Self
Construct from the component parts shared with NodeDbLite.
Sourcepub fn replica_id(&self) -> u64
pub fn replica_id(&self) -> u64
The stable replica identity for this Lite peer.
Used by the transport layer to construct ArrayAckMsg bodies.
Source§impl<S: StorageEngine> ArrayInbound<S>
impl<S: StorageEngine> ArrayInbound<S>
Sourcepub async fn handle_reject(
&self,
msg: &ArrayRejectMsg,
) -> Result<InboundOutcome, LiteError>
pub async fn handle_reject( &self, msg: &ArrayRejectMsg, ) -> Result<InboundOutcome, LiteError>
Process a reject message from Origin.
Drop: removes the op from the pending queue and logs the loss at error level.CatchUp: persists the array’s catch-up flag, so the next catch-up request starts atHlc::ZERO.ResendSchemaandPark: keep the op queued and log the reject.
Returns InboundOutcome::RejectAcknowledged in every case, including
a Drop for an op no longer queued.
Source§impl<S: StorageEngine> ArrayInbound<S>
impl<S: StorageEngine> ArrayInbound<S>
Sourcepub fn catchup_tracker(&self) -> &Arc<CatchupTracker<S>> ⓘ
pub fn catchup_tracker(&self) -> &Arc<CatchupTracker<S>> ⓘ
The per-array high-water mark of ops applied from Origin.
Sourcepub fn begin_catchup_round(
&self,
) -> Result<Vec<ArrayCatchupRequestMsg>, LiteError>
pub fn begin_catchup_round( &self, ) -> Result<Vec<ArrayCatchupRequestMsg>, LiteError>
Start the catch-up round for a new session.
Drops partial snapshot assemblies left by the previous session, then
returns one ArrayCatchupRequestMsg per array in the local schema
registry, sorted by name. Each request starts at the tracker’s
last-seen HLC, or at nodedb_array::sync::hlc::Hlc::ZERO for an
array a RetentionFloor reject flagged. Returns an empty list when
the replica holds no arrays.
Source§impl<S: StorageEngine> ArrayInbound<S>
impl<S: StorageEngine> ArrayInbound<S>
Sourcepub async fn handle_schema(
&self,
msg: &ArraySchemaSyncMsg,
) -> Result<InboundOutcome, LiteError>
pub async fn handle_schema( &self, msg: &ArraySchemaSyncMsg, ) -> Result<InboundOutcome, LiteError>
Import a schema CRDT snapshot from Origin.
Updates the local crate::sync::array::SchemaRegistry with the Loro
snapshot payload. After import, ops targeting this array that
previously returned SchemaTooNew may succeed on retry.
Source§impl<S: StorageEngine> ArrayInbound<S>
impl<S: StorageEngine> ArrayInbound<S>
Sourcepub fn handle_snapshot_header(
&self,
msg: &ArraySnapshotMsg,
) -> Result<InboundOutcome, LiteError>
pub fn handle_snapshot_header( &self, msg: &ArraySnapshotMsg, ) -> Result<InboundOutcome, LiteError>
Buffer an incoming snapshot header.
Must arrive before any Self::handle_snapshot_chunk calls for the
same (array, snapshot_hlc); Origin sends the header first on the
same ordered stream. A repeated header restarts the assembly, so a
transfer Origin re-sends after a reconnect never mixes with stale
chunks. Returns SnapshotPartial { received: 0, total }.
Sourcepub fn handle_snapshot_chunk(
&self,
msg: &ArraySnapshotChunkMsg,
) -> Result<InboundOutcome, LiteError>
pub fn handle_snapshot_chunk( &self, msg: &ArraySnapshotChunkMsg, ) -> Result<InboundOutcome, LiteError>
Buffer a snapshot chunk and, when all chunks have arrived, assemble and apply the snapshot.
Returns InboundOutcome::SnapshotPartial until the last chunk
arrives, then returns InboundOutcome::SnapshotApplied after all
ops in the assembled snapshot have been applied. A chunk that does not
match its header is an error and drops the assembly. A complete
assembly leaves the buffer before it is decoded, so a decode or apply
error never leaves chunks behind.
Sourcepub fn discard_partial_snapshots(&self) -> Result<(), LiteError>
pub fn discard_partial_snapshots(&self) -> Result<(), LiteError>
Drop every partial snapshot assembly.
Called when a new session starts its catch-up round. Origin re-sends a whole snapshot for each catch-up request, so a partial assembly from a closed session can never complete.
Auto Trait Implementations§
impl<S> !Freeze for ArrayInbound<S>
impl<S> !RefUnwindSafe for ArrayInbound<S>
impl<S> !UnwindSafe for ArrayInbound<S>
impl<S> Send for ArrayInbound<S>where
Arc<LiteApplyEngine<S>>: Send,
Arc<SchemaRegistry<S>>: Send,
Arc<PendingQueue<S>>: Send,
Arc<CatchupTracker<S>>: Send,
impl<S> Sync for ArrayInbound<S>where
Arc<LiteApplyEngine<S>>: Sync,
Arc<SchemaRegistry<S>>: Sync,
Arc<PendingQueue<S>>: Sync,
Arc<CatchupTracker<S>>: Sync,
impl<S> Unpin for ArrayInbound<S>where
Arc<LiteApplyEngine<S>>: Unpin,
Arc<SchemaRegistry<S>>: Unpin,
Arc<PendingQueue<S>>: Unpin,
Arc<CatchupTracker<S>>: Unpin,
impl<S> UnsafeUnpin for ArrayInbound<S>where
Arc<LiteApplyEngine<S>>: UnsafeUnpin,
Arc<SchemaRegistry<S>>: UnsafeUnpin,
Arc<PendingQueue<S>>: UnsafeUnpin,
Arc<CatchupTracker<S>>: UnsafeUnpin,
Blanket Implementations§
Source§impl<T> ArchivePointee for T
impl<T> ArchivePointee for T
Source§type ArchivedMetadata = ()
type ArchivedMetadata = ()
Source§fn pointer_metadata(
_: &<T as ArchivePointee>::ArchivedMetadata,
) -> <T as Pointee>::Metadata
fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
impl<T> ErasedDestructor for Twhere
T: 'static,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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 moreSource§impl<T> LayoutRaw for T
impl<T> LayoutRaw for T
Source§fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
Source§impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
Source§unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
Source§fn resolve_niched(out: Place<NichedOption<T, N1>>)
fn resolve_niched(out: Place<NichedOption<T, N1>>)
out indicating that a T is niched.impl<T> NodeDbMarker for T
Source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);Source§impl<T> Pointable for T
impl<T> Pointable for T
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self to the equivalent element of its superset.