Enum bonsaidb::core::schema::view::ViewUpdatePolicy

pub enum ViewUpdatePolicy {
    Lazy,
    Eager,
    Unique,
}

The policy under which a View is updated when documents are saved.

Variants

Lazy

The view is updated when a query is made. If a document is updated multiple times between queries, the view will only be updated when the query is executed.

Eager

The view is updated during the transaction where documents are being inserted, updated, or removed.

Unique

No two documents may emit the same key. Unique views are updated when the document is saved, allowing for this check to be done atomically. When a document is updated, all unique views will be updated, and if any of them fail, the document will not be allowed to update and an Error::UniqueKeyViolation will be returned.

Implementations

impl ViewUpdatePolicy

pub const fn is_eager(&self) -> bool

Returns true if the view should be updated eagerly.

This returns true if the policy is either Eager or Unique.

Trait Implementations

impl Clone for ViewUpdatePolicy

fn clone(&self) -> ViewUpdatePolicy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ViewUpdatePolicy

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

Formats the value using the given formatter.

impl Default for ViewUpdatePolicy

fn default() -> ViewUpdatePolicy

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ViewUpdatePolicy

fn deserialize<__D>( __deserializer: __D ) -> Result<ViewUpdatePolicy, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ViewUpdatePolicy

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

Formats the value using the given formatter.

impl PartialEq for ViewUpdatePolicy

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for ViewUpdatePolicy

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for ViewUpdatePolicy

impl Eq for ViewUpdatePolicy

impl StructuralEq for ViewUpdatePolicy

impl StructuralPartialEq for ViewUpdatePolicy