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 insert_batch( &self, items: impl IntoIterator<Item = (String, T)>, ) -> Result<(), CollectionError>

Insert or update multiple items in a batch

Source

pub async fn update_batch( &self, updates: impl IntoIterator<Item = (String, T)>, ) -> Result<(), CollectionError>

Update multiple items in a batch

Source

pub async fn remove_batch( &self, keys: impl IntoIterator<Item = String>, ) -> Result<(), CollectionError>

Remove multiple items in a batch

Source

pub async fn get_batch( &self, keys: impl IntoIterator<Item = String>, ) -> Result<Vec<(String, Option<T>)>, CollectionError>

Get multiple items by keys

Source

pub async fn contains_keys( &self, keys: impl IntoIterator<Item = String>, ) -> Result<Vec<(String, bool)>, CollectionError>

Check if multiple keys exist

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<E, T, Request, Encoding> FromReq<Patch<Encoding>, Request, E> for T
where Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_req(req: Request) -> Result<T, E>

Attempts to deserialize the arguments from a request.
Source§

impl<E, T, Request, Encoding> FromReq<Post<Encoding>, Request, E> for T
where Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_req(req: Request) -> Result<T, E>

Attempts to deserialize the arguments from a request.
Source§

impl<E, T, Request, Encoding> FromReq<Put<Encoding>, Request, E> for T
where Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_req(req: Request) -> Result<T, E>

Attempts to deserialize the arguments from a request.
Source§

impl<E, Encoding, Response, T> FromRes<Patch<Encoding>, Response, E> for T
where Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_res(res: Response) -> Result<T, E>

Attempts to deserialize the outputs from a response.
Source§

impl<E, Encoding, Response, T> FromRes<Post<Encoding>, Response, E> for T
where Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_res(res: Response) -> Result<T, E>

Attempts to deserialize the outputs from a response.
Source§

impl<E, Encoding, Response, T> FromRes<Put<Encoding>, Response, E> for T
where Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_res(res: Response) -> Result<T, E>

Attempts to deserialize the outputs from a response.
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<E, T, Encoding, Request> IntoReq<Patch<Encoding>, Request, E> for T
where Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

Source§

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.
Source§

impl<E, T, Encoding, Request> IntoReq<Post<Encoding>, Request, E> for T
where Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

Source§

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.
Source§

impl<E, T, Encoding, Request> IntoReq<Put<Encoding>, Request, E> for T
where Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

Source§

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.
Source§

impl<E, Response, Encoding, T> IntoRes<Patch<Encoding>, Response, E> for T
where Response: TryRes<E>, Encoding: Encodes<T>, E: FromServerFnError + Send, T: Send,

Source§

async fn into_res(self) -> Result<Response, E>

Attempts to serialize the output into an HTTP response.
Source§

impl<E, Response, Encoding, T> IntoRes<Post<Encoding>, Response, E> for T
where Response: TryRes<E>, Encoding: Encodes<T>, E: FromServerFnError + Send, T: Send,

Source§

async fn into_res(self) -> Result<Response, E>

Attempts to serialize the output into an HTTP response.
Source§

impl<E, Response, Encoding, T> IntoRes<Put<Encoding>, Response, E> for T
where Response: TryRes<E>, Encoding: Encodes<T>, E: FromServerFnError + Send, T: Send,

Source§

async fn into_res(self) -> Result<Response, E>

Attempts to serialize the output into an HTTP response.
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> SerializableKey for T

Source§

fn ser_key(&self) -> String

Serializes the key to a unique string. Read more
Source§

impl<T> StorageAccess<T> for T

Source§

fn as_borrowed(&self) -> &T

Borrows the value.
Source§

fn into_taken(self) -> T

Takes the value.
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
Source§

impl<T> ErasedDestructor for T
where T: 'static,