OnDisconnect

Struct OnDisconnect 

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

Async handle for scheduling writes that run when the client disconnects.

Mirrors the surface of the JS SDK (packages/database/src/api/OnDisconnect.ts). Operations resolve server value placeholders before being sent to the realtime backend and require an active WebSocket transport for full server-side semantics. When the runtime falls back to the HTTP long-poll transport the commands are queued locally and flushed when Database::go_offline() runs, which preserves graceful shutdowns but cannot detect abrupt connection loss.

Implementations§

Source§

impl OnDisconnect

Source

pub async fn set<V>(&self, value: V) -> DatabaseResult<()>
where V: Into<Value>,

Schedules a write for when the client disconnects.

Mirrors OnDisconnect.set() from the JS SDK. The payload is normalised using the same server timestamp/increment resolution as immediate writes so placeholders resolve against the current backend value.

Source

pub async fn set_with_priority<V, P>( &self, value: V, priority: P, ) -> DatabaseResult<()>
where V: Into<Value>, P: Into<Value>,

Schedules a write together with its priority for disconnect.

Source

pub async fn update( &self, updates: JsonMap<String, Value>, ) -> DatabaseResult<()>

Schedules an update when the client disconnects.

Source

pub async fn remove(&self) -> DatabaseResult<()>

Ensures the value at this location is deleted when the client disconnects.

Source

pub async fn cancel(&self) -> DatabaseResult<()>

Cancels all pending on-disconnect operations.

Trait Implementations§

Source§

impl Clone for OnDisconnect

Source§

fn clone(&self) -> OnDisconnect

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for OnDisconnect

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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,