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

SyncStateManager

Struct SyncStateManager 

Source
pub struct SyncStateManager<'a> { /* private fields */ }
Expand description

Manages sync state persistence in the sync tree.

Implementations§

Source§

impl<'a> SyncStateManager<'a>

Source

pub fn new(txn: &'a Transaction) -> Self

Create a new sync state manager.

Source

pub async fn get_sync_cursor( &self, peer_pubkey: &PublicKey, tree_id: &ID, clock: &dyn Clock, ) -> Result<SyncCursor>

Get or create a sync cursor for a peer-tree relationship.

§Arguments
  • peer_pubkey - The peer’s public key
  • tree_id - The tree ID this cursor applies to
  • clock - The time provider for timestamps (used when creating new cursor)
Source

pub async fn update_sync_cursor(&self, cursor: &SyncCursor) -> Result<()>

Update a sync cursor.

Source

pub async fn get_sync_metadata( &self, peer_pubkey: &PublicKey, clock: &dyn Clock, ) -> Result<SyncMetadata>

Get or create sync metadata for a peer.

§Arguments
  • peer_pubkey - The peer’s public key
  • clock - The time provider for timestamps (used when creating new metadata)
Source

pub async fn update_sync_metadata(&self, metadata: &SyncMetadata) -> Result<()>

Update sync metadata for a peer.

Source

pub async fn add_sync_history( &self, history_entry: &SyncHistoryEntry, ) -> Result<()>

Add a sync history entry.

Source

pub async fn get_sync_history( &self, peer_pubkey: &PublicKey, limit: Option<usize>, ) -> Result<Vec<SyncHistoryEntry>>

Get sync history for a peer, optionally limited to recent entries.

§Implementation Note

This method navigates the nested map structure created by DocStore::set_path(). When using set_path("history.sync_id", data), it creates a nested structure { "history": { "sync_id": data } } rather than a flat key with dots.

Source

pub async fn get_peers_with_sync_state(&self) -> Result<Vec<PublicKey>>

Get all peers with sync state.

§Implementation Note

This method navigates the nested map structure created by DocStore::set_path(). The data is organized in nested maps like { "metadata": { "peer_key": data } } and { "cursors": { "peer_key": { "tree_id": data } } }.

Source

pub async fn cleanup_old_history( &self, max_age_days: u32, clock: &dyn Clock, ) -> Result<usize>

Clean up old sync history entries.

§Arguments
  • max_age_days - Maximum age of history entries to keep (older entries are deleted)
  • clock - The time provider for determining current time
§Implementation Note

This method navigates the nested map structure created by DocStore::set_path(). History entries are stored as { "history": { "sync_id": data } } and the method properly navigates this structure to find and clean old entries.

Auto Trait Implementations§

§

impl<'a> Freeze for SyncStateManager<'a>

§

impl<'a> !RefUnwindSafe for SyncStateManager<'a>

§

impl<'a> Send for SyncStateManager<'a>

§

impl<'a> Sync for SyncStateManager<'a>

§

impl<'a> Unpin for SyncStateManager<'a>

§

impl<'a> !UnwindSafe for SyncStateManager<'a>

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
§

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