Struct PutEntry 

#[non_exhaustive]
pub struct PutEntry {
    pub key: Option<String>,
    pub value: Option<Document>,
}

A new entry to insert into the key-value database.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

key: Option<String>

A string reprenting a key in the key-value database. Key path components are split by a slash (e.g. a/b/c has the path components ["a", "b", "c"]). Slashes can be escaped by using a forward slash (e.g. a/b\/c/d has the path components ["a", "b/c", "d"]). See rivet.api.kv.common#KeyComponents for the structure of a rivet.api.kv.common#Key split by /.

value: Option<Document>

Implementations

impl PutEntry

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

A string reprenting a key in the key-value database. Key path components are split by a slash (e.g. a/b/c has the path components ["a", "b", "c"]). Slashes can be escaped by using a forward slash (e.g. a/b\/c/d has the path components ["a", "b/c", "d"]). See rivet.api.kv.common#KeyComponents for the structure of a rivet.api.kv.common#Key split by /.

pub fn value(&self) -> Option<&Document>

impl PutEntry

pub fn builder() -> Builder

Creates a new builder-style object to manufacture PutEntry

Trait Implementations

impl Clone for PutEntry

fn clone(&self) -> PutEntry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PutEntry

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

Formats the value using the given formatter.

impl PartialEq for PutEntry

fn eq(&self, other: &PutEntry) -> 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 StructuralPartialEq for PutEntry