Struct TableUpdate

pub struct TableUpdate<F>
where
    F: WebsocketFormat,
{
    pub table_id: TableId,
    pub table_name: Box<str>,
    pub num_rows: u64,
    pub updates: SmallVec<[<F as WebsocketFormat>::QueryUpdate; 1]>,
}

Part of a DatabaseUpdate received by client from database for alterations to a single table.

NOTE(centril): in 0.12 we added num_rows and table_name to the struct. These inflate the size of messages, which for some customers is the wrong default. We might want to consider v1.spacetimedb.bsatn.lightweight

Fields

table_id: TableId

The id of the table. Clients should prefer table_name, as it is a stable part of a module’s API, whereas table_id may change between runs.

table_name: Box<str>

The name of the table.

NOTE(centril, 1.0): we might want to remove this and instead tell clients about changes to table_name <-> table_id mappings.

num_rows: u64

The sum total of rows in self.updates,

updates: SmallVec<[<F as WebsocketFormat>::QueryUpdate; 1]>

The actual insert and delete updates for this table.

Implementations

impl<F> TableUpdate<F>

where F: WebsocketFormat,

pub fn new( table_id: TableId, table_name: Box<str>, update: SingleQueryUpdate<F>, ) -> TableUpdate<F>

pub fn empty(table_id: TableId, table_name: Box<str>) -> TableUpdate<F>

pub fn push(&mut self, update: SingleQueryUpdate<F>)

pub fn num_rows(&self) -> usize

Trait Implementations

impl<F> Clone for TableUpdate<F>

where F: Clone + WebsocketFormat, <F as WebsocketFormat>::QueryUpdate: Clone,

fn clone(&self) -> TableUpdate<F>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F> Debug for TableUpdate<F>

where F: Debug + WebsocketFormat, <F as WebsocketFormat>::QueryUpdate: Debug,

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

Formats the value using the given formatter.

impl<'de, F> Deserialize<'de> for TableUpdate<F>

where F: WebsocketFormat + Deserialize<'de>,

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

where D: Deserializer<'de>,

Deserialize this value from the given deserializer.

impl<F> FromIterator<TableUpdate<F>> for DatabaseUpdate<F>

where F: WebsocketFormat,

fn from_iter<T>(iter: T) -> DatabaseUpdate<F>

where T: IntoIterator<Item = TableUpdate<F>>,

Creates a value from an iterator.

impl<F> Serialize for TableUpdate<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 TableUpdate<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.