Skip to main content

BackendEvent

Enum BackendEvent 

Source
pub enum BackendEvent {
    Synced {
        upserted: usize,
        removed: usize,
    },
    FileChanged {
        path: PathBuf,
    },
    FileRemoved {
        path: PathBuf,
    },
    Error {
        message: String,
    },
    SyncDelivered {
        device_id: GrainId,
        device_name: String,
    },
}
Expand description

Events a server publishes so a client can react without polling.

Variants§

§

Synced

A sync cycle finished.

Fields

§upserted: usize

Documents added/updated.

§removed: usize

Documents removed.

§

FileChanged

A single file changed through the server.

Fields

§path: PathBuf

The affected path.

§

FileRemoved

A single file was removed through the server.

Fields

§path: PathBuf

The affected path.

§

Error

A background operation failed. Carries a human-readable message.

Fields

§message: String

Failure description.

§

SyncDelivered

Every edit this device made to the synced workspace has reached at least one peer: the peer applied it and wrote its content, so it survives this device going to sleep or away.

Sent once per batch of edits, when the last of them lands, not once per peer: a second peer catching up later says nothing new. Edits made before sync started on this server are not waited for. SyncStatusResult::pending_delivery says the same thing to a client that asks instead.

Fields

§device_id: GrainId

The peer that confirmed them.

§device_name: String

That peer’s name, as the workgroup lists it; its id when the name is not known.

Trait Implementations§

Source§

impl Clone for BackendEvent

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BackendEvent

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for BackendEvent

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for BackendEvent

Source§

impl PartialEq for BackendEvent

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for BackendEvent

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for BackendEvent

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.