Struct surrealdb::Notification

#[non_exhaustive]
pub struct Notification<R> {
    pub query_id: Uuid,
    pub action: Action,
    pub data: R,
}

A live query notification

Live queries return a stream of notifications. The notification contains an action that triggered the change in the database record and data itself. For deletions the data is the record before it was deleted. For everything else, it’s the newly created record or updated record depending on whether the action is create or update.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

query_id: Uuid

action: Action

data: R

Trait Implementations

impl<R: Clone> Clone for Notification<R>

fn clone(&self) -> Notification<R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R: Debug> Debug for Notification<R>

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

Formats the value using the given formatter.

impl<R: Hash> Hash for Notification<R>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<R: Ord> Ord for Notification<R>

fn cmp(&self, other: &Notification<R>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<R: PartialEq> PartialEq for Notification<R>

fn eq(&self, other: &Notification<R>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<R: PartialOrd> PartialOrd for Notification<R>

fn partial_cmp(&self, other: &Notification<R>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<R> QueryStream<Notification<R>> for ()

where R: DeserializeOwned + Unpin,

fn query_stream( self, response: &mut QueryResponse, ) -> Result<QueryStream<Notification<R>>>

Retrieves the query stream future

impl<R> QueryStream<Notification<R>> for usize

where R: DeserializeOwned + Unpin,

fn query_stream( self, response: &mut QueryResponse, ) -> Result<QueryStream<Notification<R>>>

Retrieves the query stream future

impl<R: Copy> Copy for Notification<R>

impl<R: Eq> Eq for Notification<R>

impl<R> StructuralPartialEq for Notification<R>