Skip to main content

SyncedTable

Struct SyncedTable 

Source
pub struct SyncedTable { /* private fields */ }
Expand description

A synced table’s key, audience, file references, shared triggers and who may change its rows directly (E2).

Implementations§

Source§

impl SyncedTable

Source

pub fn name(&self) -> &str

The table name exactly as supplied to the declaration.

Source

pub fn identity(&self) -> &RowIdentity

The declared kind of row identity.

Source

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

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

Source

pub fn write_permission(&self) -> WritePermission

Who may change the table’s rows directly.

Source

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.

Source

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.

Source

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

The declared file reference columns, in declaration order.

Source

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

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

Source

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

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

Source

pub fn owner_only(self) -> Self

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 a table’s write permission is a breaking schema change (§18.1).

Source

pub fn admin_only(self) -> Self

Only a member who is an admin as of the write’s slot may directly insert, update or delete its rows, whoever created them (§9.6). Shared-trigger targets count as direct writes; foreign-key actions from authorized changes may still reach the row. Changing a table’s write permission is a breaking schema change (§18.1).

Source

pub fn key_columns<I, S>(self, columns: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

The columns in PRIMARY KEY order.

Source

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

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

Source

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

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

Source

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

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

Source

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

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

Trait Implementations§

Source§

impl Clone for SyncedTable

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SyncedTable

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for SyncedTable

Source§

impl PartialEq for SyncedTable

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SyncedTable

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

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

Source§

impl<T> From<T> for T

Source§

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
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
§

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