Struct SyncedTable 

pub struct SyncedTable { /* private fields */ }

A synced table’s key, audience, file references, shared triggers and whether only each row’s original creator writes it directly (E2).

Implementations

impl SyncedTable

pub fn name(&self) -> &str

The table name exactly as supplied to the declaration.

pub fn identity(&self) -> &RowIdentity

The declared kind of row identity.

pub fn get_key_columns(&self) -> &[String]

The declared primary-key columns, in order; defaults to id.

pub fn is_owner_only(&self) -> bool

Whether direct writes are restricted to each row’s original creator.

pub fn get_audience_column(&self) -> Option<&str>

The root audience column, including when inheritance was also declared. Opening refuses a declaration with both audience sources.

pub fn get_audience_from(&self) -> Option<&str>

The audience foreign key, including when a root column was also declared. Opening refuses a declaration with both audience sources.

pub fn file_columns(&self) -> &[FileColumn]

The declared file reference columns, in declaration order.

pub fn shared_triggers(&self) -> &[String]

The shared trigger names, in declaration order, including repetitions.

pub fn new(name: impl Into<String>, identity: RowIdentity) -> SyncedTable

Declare a synced table with the one-column primary key id.

pub fn owner_only(self) -> SyncedTable

Only each row’s original creating member may directly update or delete it (§9.6). Shared-trigger targets count as direct writes; foreign-key actions from authorized changes may still reach the row. No app owner column is needed. Changing this declaration for an existing table is a breaking schema change (§18.1).

pub fn key_columns<I, S>(self, columns: I) -> SyncedTable

where I: IntoIterator<Item = S>, S: Into<String>,

The columns in PRIMARY KEY order.

pub fn audience_column(self, column: impl Into<String>) -> SyncedTable

Set the root’s non-null text audience column. Declaring inheritance too is an error.

pub fn audience_from(self, foreign_key: impl Into<String>) -> SyncedTable

Inherit the audience through this foreign key. Declaring a root column too is an error.

pub fn file_column(self, column: FileColumn) -> SyncedTable

Declare a column holding a file reference. Opening and migrating check the column against this synced table’s actual schema.

pub fn shared_trigger(self, name: impl Into<String>) -> SyncedTable

Declare a trigger as shared; all other triggers are local.

Trait Implementations

impl Clone for SyncedTable

fn clone(&self) -> SyncedTable

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SyncedTable

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

Formats the value using the given formatter.

impl PartialEq for SyncedTable

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for SyncedTable

impl StructuralPartialEq for SyncedTable