LocalFirstCollection

Struct LocalFirstCollection 

Source
pub struct LocalFirstCollection<T, Tr>
where T: Clone + Send + Sync + Serialize + for<'de> Deserialize<'de> + Mergeable + Default, Tr: SyncTransport + Clone + 'static,
{ /* private fields */ }
Expand description

Local-first collection that can synchronize with remote peers

Implementations§

Source§

impl<T, Tr> LocalFirstCollection<T, Tr>
where T: Clone + Send + Sync + Serialize + for<'de> Deserialize<'de> + Mergeable + Default, Tr: SyncTransport + Clone + 'static,

Source

pub fn new(storage: Storage, transport: Tr) -> Self

Create a new collection

Source

pub fn with_replica_id( storage: Storage, transport: Tr, replica_id: ReplicaId, ) -> Self

Create a collection with a specific replica ID

Source

pub fn replica_id(&self) -> ReplicaId

Get the replica ID for this collection

Source

pub async fn insert(&self, key: &str, value: &T) -> Result<(), CollectionError>

Insert or update an item

Source

pub async fn get(&self, key: &str) -> Result<Option<T>, CollectionError>

Get an item by key

Source

pub async fn remove(&self, key: &str) -> Result<(), CollectionError>

Remove an item

Source

pub async fn keys(&self) -> Result<Vec<String>, CollectionError>

Get all keys

Source

pub async fn values(&self) -> Result<Vec<T>, CollectionError>

Get all values

Source

pub async fn contains_key(&self, key: &str) -> Result<bool, CollectionError>

Check if a key exists

Source

pub async fn len(&self) -> Result<usize, CollectionError>

Get the number of items

Source

pub async fn is_empty(&self) -> Result<bool, CollectionError>

Check if the collection is empty

Source

pub async fn start_sync(&self) -> Result<(), CollectionError>

Start synchronization

Source

pub async fn stop_sync(&self) -> Result<(), CollectionError>

Stop synchronization

Source

pub async fn sync_state(&self) -> Result<SyncState, CollectionError>

Get synchronization state

Source

pub async fn is_online(&self) -> Result<bool, CollectionError>

Check if online

Source

pub async fn peer_count(&self) -> Result<usize, CollectionError>

Get peer count

Source

pub fn set_auto_sync(&mut self, enabled: bool)

Set auto-sync mode

Source

pub async fn force_sync(&self) -> Result<(), CollectionError>

Force synchronization

Source

pub async fn peers( &self, ) -> Result<impl Iterator<Item = (ReplicaId, PeerInfo)>, CollectionError>

Get all peers

Source

pub async fn sync_info(&self) -> Result<SyncInfo, CollectionError>

Get sync information

Auto Trait Implementations§

§

impl<T, Tr> Freeze for LocalFirstCollection<T, Tr>

§

impl<T, Tr> !RefUnwindSafe for LocalFirstCollection<T, Tr>

§

impl<T, Tr> Send for LocalFirstCollection<T, Tr>

§

impl<T, Tr> Sync for LocalFirstCollection<T, Tr>

§

impl<T, Tr> Unpin for LocalFirstCollection<T, Tr>
where T: Unpin,

§

impl<T, Tr> !UnwindSafe for LocalFirstCollection<T, Tr>

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