spacetimedb::messages::websocket

Enum ServerMessage

pub enum ServerMessage<F>where
    F: WebsocketFormat,{
    InitialSubscription(InitialSubscription<F>),
    TransactionUpdate(TransactionUpdate<F>),
    TransactionUpdateLight(TransactionUpdateLight<F>),
    IdentityToken(IdentityToken),
    OneOffQueryResponse(OneOffQueryResponse<F>),
    SubscribeApplied(SubscribeApplied<F>),
    UnsubscribeApplied(UnsubscribeApplied<F>),
    SubscriptionError(SubscriptionError),
    SubscribeMultiApplied(SubscribeMultiApplied<F>),
    UnsubscribeMultiApplied(UnsubscribeMultiApplied<F>),
}

Expand description

Messages sent from the server to the client.

Variants§

InitialSubscription(InitialSubscription<F>)

Informs of changes to subscribed rows. This will be removed when we switch to SubscribeSingle.

TransactionUpdate(TransactionUpdate<F>)

Upon reducer run.

TransactionUpdateLight(TransactionUpdateLight<F>)

Upon reducer run, but limited to just the table updates.

IdentityToken(IdentityToken)

After connecting, to inform client of its identity.

OneOffQueryResponse(OneOffQueryResponse<F>)

Return results to a one off SQL query.

SubscribeApplied(SubscribeApplied<F>)

Sent in response to a SubscribeSingle message. This contains the initial matching rows.

UnsubscribeApplied(UnsubscribeApplied<F>)

Sent in response to an Unsubscribe message. This contains the matching rows.

SubscriptionError(SubscriptionError)

Communicate an error in the subscription lifecycle.

SubscribeMultiApplied(SubscribeMultiApplied<F>)

Sent in response to a SubscribeMulti message. This contains the initial matching rows.

UnsubscribeMultiApplied(UnsubscribeMultiApplied<F>)

Sent in response to an UnsubscribeMulti message. This contains the matching rows.

Trait Implementations§

impl<'de, F> Deserialize<'de> for ServerMessage<F>
where F: WebsocketFormat + Deserialize<'de>,

fn deserialize<D>( deserializer: D, ) -> Result<ServerMessage<F>, <D as Deserializer<'de>>::Error>
where D: Deserializer<'de>,

Deserialize this value from the given deserializer.

impl<F> From<IdentityToken> for ServerMessage<F>
where F: WebsocketFormat,

fn from(original: IdentityToken) -> ServerMessage<F>

Converts to this type from the input type.

impl<F> From<InitialSubscription<F>> for ServerMessage<F>
where F: WebsocketFormat,

fn from(original: InitialSubscription<F>) -> ServerMessage<F>

Converts to this type from the input type.

impl<F> From<OneOffQueryResponse<F>> for ServerMessage<F>
where F: WebsocketFormat,

fn from(original: OneOffQueryResponse<F>) -> ServerMessage<F>

Converts to this type from the input type.

impl<F> From<SubscribeApplied<F>> for ServerMessage<F>
where F: WebsocketFormat,

fn from(original: SubscribeApplied<F>) -> ServerMessage<F>

Converts to this type from the input type.

impl<F> From<SubscribeMultiApplied<F>> for ServerMessage<F>
where F: WebsocketFormat,

fn from(original: SubscribeMultiApplied<F>) -> ServerMessage<F>

Converts to this type from the input type.

impl<F> From<SubscriptionError> for ServerMessage<F>
where F: WebsocketFormat,

fn from(original: SubscriptionError) -> ServerMessage<F>

Converts to this type from the input type.

impl<F> From<TransactionUpdate<F>> for ServerMessage<F>
where F: WebsocketFormat,

fn from(original: TransactionUpdate<F>) -> ServerMessage<F>

Converts to this type from the input type.

impl<F> From<TransactionUpdateLight<F>> for ServerMessage<F>
where F: WebsocketFormat,

fn from(original: TransactionUpdateLight<F>) -> ServerMessage<F>

Converts to this type from the input type.

impl<F> From<UnsubscribeApplied<F>> for ServerMessage<F>
where F: WebsocketFormat,

fn from(original: UnsubscribeApplied<F>) -> ServerMessage<F>

Converts to this type from the input type.

impl<F> From<UnsubscribeMultiApplied<F>> for ServerMessage<F>
where F: WebsocketFormat,

fn from(original: UnsubscribeMultiApplied<F>) -> ServerMessage<F>

Converts to this type from the input type.

impl<F> Serialize for ServerMessage<F>
where F: WebsocketFormat + Serialize,

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

Serialize self in the data format of S using the provided serializer.

impl<F> SpacetimeType for ServerMessage<F>
where F: WebsocketFormat + SpacetimeType + 'static,

fn make_type<S>(__typespace: &mut S) -> AlgebraicType
where S: TypespaceBuilder,

Returns an AlgebraicType representing the type for Self in SATS and in the typing context in typespace. This is used by the automatic type registration system in Rust modules. Read more

Auto Trait Implementations§

impl<F> Freeze for ServerMessage<F>
where <F as WebsocketFormat>::Single: Freeze, <F as WebsocketFormat>::QueryUpdate: Freeze,

impl<F> RefUnwindSafe for ServerMessage<F>
where <F as WebsocketFormat>::Single: RefUnwindSafe, <F as WebsocketFormat>::List: RefUnwindSafe, <F as WebsocketFormat>::QueryUpdate: RefUnwindSafe,

impl<F> Send for ServerMessage<F>
where <F as WebsocketFormat>::Single: Send, <F as WebsocketFormat>::List: Send,

impl<F> Sync for ServerMessage<F>
where <F as WebsocketFormat>::Single: Sync, <F as WebsocketFormat>::List: Sync, <F as WebsocketFormat>::QueryUpdate: Sync,

impl<F> Unpin for ServerMessage<F>
where <F as WebsocketFormat>::Single: Unpin, <F as WebsocketFormat>::QueryUpdate: Unpin,

impl<F> UnwindSafe for ServerMessage<F>
where <F as WebsocketFormat>::Single: UnwindSafe, <F as WebsocketFormat>::List: UnwindSafe, <F as WebsocketFormat>::QueryUpdate: RefUnwindSafe + UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

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

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

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> Satn for T
where T: Serialize + ?Sized,

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

Formats the value using the SATN data format into the formatter f.

fn fmt_psql( &self, f: &mut Formatter<'_>, ty: &PsqlType<'_>, ) -> Result<(), Error>

Formats the value using the postgres SATN(PsqlFormatter { f }, /* PsqlType */) formatter f.

fn to_satn(&self) -> String

Formats the value using the SATN data format into the returned String.

fn to_satn_pretty(&self) -> String

Pretty prints the value using the SATN data format into the returned String.

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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

impl<T> MaybeSendSync for T