Skip to main content

TaskListSync

Struct TaskListSync 

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

Synchronization wrapper for a TaskList.

Manages automatic background synchronization of a TaskList using anti-entropy gossip. Changes are propagated via deltas published to a gossip topic.

Implementations§

Source§

impl TaskListSync

Source

pub fn new( task_list: TaskList, pubsub: Arc<PubSubManager>, topic: String, sync_interval_secs: u64, ) -> Result<Self>

Create a new TaskList synchronization manager.

§Arguments
  • task_list - The TaskList to synchronize
  • pubsub - Pub/sub manager for gossip messaging
  • topic - Topic name for pub/sub (typically task list ID)
  • sync_interval_secs - How often to run anti-entropy (seconds)
§Returns

A new TaskListSync instance ready to start.

§Errors

Returns an error if initialization fails.

§Example
let task_list = TaskList::new(id, "My List".to_string(), peer_id);
let sync = TaskListSync::new(
    task_list,
    pubsub,
    "tasklist-abc123".to_string(),
    30, // Sync every 30 seconds
)?;
Source

pub async fn start(&self) -> Result<()>

Start background synchronization.

Subscribes to the gossip topic and begins receiving remote deltas. This method returns immediately; synchronization runs in the background.

§Returns

Ok(()) if started successfully.

§Errors

Returns an error if subscription or anti-entropy startup fails.

Source

pub async fn stop(&self) -> Result<()>

Stop background synchronization.

Unsubscribes from the gossip topic.

§Returns

Ok(()) if stopped successfully.

§Errors

Returns an error if operations fail.

Source

pub async fn apply_remote_delta( &self, peer_id: PeerId, delta: TaskListDelta, ) -> Result<()>

Apply a delta received from a remote peer.

This is called when a delta is received via the gossip topic. The delta is merged into the local TaskList using CRDT semantics.

§Arguments
  • peer_id - The peer who sent this delta
  • delta - The delta to apply
§Returns

Ok(()) if the delta was applied successfully.

§Errors

Returns an error if the merge fails.

Source

pub async fn publish_delta( &self, local_peer_id: PeerId, delta: TaskListDelta, ) -> Result<()>

Publish a local delta to the gossip network.

Call this after making local changes to propagate them to other peers.

§Arguments
  • local_peer_id - The local peer’s ID
  • delta - The delta to publish
§Returns

Ok(()) if published successfully.

§Errors

Returns an error if serialization or publishing fails.

Source

pub async fn read(&self) -> RwLockReadGuard<'_, TaskList>

Get a read-only reference to the task list.

Useful for querying the current state without modifying it.

§Returns

A read guard to the TaskList.

Source

pub async fn write(&self) -> RwLockWriteGuard<'_, TaskList>

Get a mutable reference to the task list.

Use this to make local changes. After modifying, call publish_delta to propagate changes to peers.

§Returns

A write guard to the TaskList.

Source

pub fn topic(&self) -> &str

Get the topic name for this task list.

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.

Source§

impl<T> Instrument for T

Source§

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

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

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

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

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

Source§

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

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

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more