Struct SubscriptionError

pub struct SubscriptionError {
    pub total_host_execution_duration_micros: u64,
    pub request_id: Option<u32>,
    pub query_id: Option<u32>,
    pub table_id: Option<TableId>,
    pub error: Box<str>,
}

Server response to an error at any point of the subscription lifecycle. If this error doesn’t have a request_id, the client should drop all subscriptions.

Fields

total_host_execution_duration_micros: u64

The overall time between the server receiving a request and sending the response.

request_id: Option<u32>

Provided by the client via a Subscribe or Unsubscribe message. None if this occurred as the result of a TransactionUpdate.

query_id: Option<u32>

Provided by the client via a Subscribe or Unsubscribe message. None if this occurred as the result of a TransactionUpdate.

table_id: Option<TableId>

The return table of the query in question. The server is not required to set this field. It has been added to avoid a breaking change post 1.0.

If unset, an error results in the entire subscription being dropped. Otherwise only queries of this table type must be dropped.

error: Box<str>

An error message describing the failure.

This should reference specific fragments of the query where applicable, but should not include the full text of the query, as the client can retrieve that from the request_id.

This is intended for diagnostic purposes. It need not have a predictable/parseable format.

Trait Implementations

impl<'de> Deserialize<'de> for SubscriptionError

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

where D: Deserializer<'de>,

Deserialize this value from the given deserializer.

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 Serialize for SubscriptionError

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 SpacetimeType for SubscriptionError

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.