Enum Capability 

#[non_exhaustive]
pub enum Capability {
    Insert,
    Update,
    Delete,
    Import,
    Subscribe,
    Order,
    Search,
    FilterOps,
    NativeConditions,
    Window,
    Cursor,
    Traverse,
    ConfineWrites,
    WritesReachHooks,
}

One method family of TableShell that a shell may or may not implement.

Each capability names exactly one family, and a shell advertising it must answer that family without refusing (the contract feature checks this):

Capability	Methods
Insert	insert
Update	replace, upsert, patch
Delete	delete, delete_all
Import	import: one atomic batch that counts only new rows
Subscribe	watch
Order	set_order
Search	set_search
FilterOps	add_condition with any operator other than Eq
NativeConditions	add_native_condition
Window	fetch_window at any offset
Cursor	fetch_cursor
Traverse	get_ref
ConfineWrites	every write keeps to the narrowed set (see WritableValueSet)
WritesReachHooks	every write runs through a Table, so its hooks (audit, generated ids, access checks) see it

list, get, count and equality conditions have no capability: every shell answers them. Nor does the leading window, fetch_window(0, n), which every shell that lists answers.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Insert

Update

Delete

Import

Subscribe

Order

Search

FilterOps

NativeConditions

Window

Cursor

Traverse

ConfineWrites

WritesReachHooks

Implementations

impl Capability

pub fn iter() -> impl Iterator<Item = Capability>

Every capability, in declaration order. Serde, the rhai capabilities() map and the contract checks all iterate this.

pub fn as_str(self) -> &'static str

The snake_case name used in serde, scripts and error context.

Trait Implementations

impl Clone for Capability

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Capability

impl Debug for Capability

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Capability

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

Deserialize this value from the given Serde deserializer.

impl Display for Capability

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

Formats the value using the given formatter.

impl Eq for Capability

impl FromIterator<Capability> for VistaCapabilities

fn from_iter<I: IntoIterator<Item = Capability>>(iter: I) -> Self

Creates a value from an iterator.

impl Hash for Capability

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Capability

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Capability

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Capability

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Capability

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Capability