Skip to main content

SyncProvider

volt_client_grpc::sync_provider

Struct SyncProvider 

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

SyncProvider manages document synchronization with Volt server

Implementations§

Source§

impl SyncProvider

Source

pub fn new( doc: Doc, database_id: impl Into<String>, document_id: impl Into<String>, ) -> (Self, Receiver<SyncEvent>)

Create a new SyncProvider

§Arguments
  • doc - The Y.js document to sync
  • database_id - ID of the database containing the document
  • document_id - ID of the document to sync
§Returns

A tuple of (SyncProvider, event_receiver)

Source

pub async fn start( &mut self, client: &VoltClient, read_only: bool, read_only_fallback: bool, ) -> Result<()>

Start synchronization with the Volt server

§Arguments
  • client - The VoltClient to use for synchronization
  • read_only - If true, only receive updates (no sending)
  • read_only_fallback - If true, downgrade to read-only if write access denied
Source

pub async fn send_update(&self, update: &[u8]) -> Result<()>

Send an update to the server

This should be called when the local document changes

Source

pub async fn state(&self) -> ProviderState

Get the current provider state

Source

pub async fn is_read_only(&self) -> bool

Check if the provider is read-only

Source

pub async fn stop(&mut self)

Stop synchronization

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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
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