Struct bonsaidb_core::transaction::Operation

pub struct Operation {
    pub collection: CollectionName,
    pub command: Command,
}

A single operation performed on a Collection.

Fields

collection: CollectionName

The id of the Collection.

command: Command

The command being performed.

Implementations

impl Operation

pub fn insert(
    collection: CollectionName,
    id: Option<DocumentId>,
    contents: impl Into<Bytes>
) -> Self

Inserts a new document with contents into collection. If id is None a unique id will be generated. If an id is provided and a document already exists with that id, a conflict error will be returned.

pub fn insert_serialized<C: SerializedCollection>(
    id: Option<C::PrimaryKey>,
    contents: &C::Contents
) -> Result<Self, Error>

Inserts a new document with the serialized representation of contents into collection. If id is None a unique id will be generated. If an id is provided and a document already exists with that id, a conflict error will be returned.

pub fn update(
    collection: CollectionName,
    header: Header,
    contents: impl Into<Bytes>
) -> Self

Updates a document in collection.

pub fn update_serialized<C: SerializedCollection>(
    header: CollectionHeader<C::PrimaryKey>,
    contents: &C::Contents
) -> Result<Self, Error>

Updates a document with the serialized representation of contents in collection.

pub fn overwrite(
    collection: CollectionName,
    id: DocumentId,
    contents: impl Into<Bytes>
) -> Self

Overwrites a document in collection. If a document with id exists, it will be overwritten. If a document with id doesn’t exist, it will be created.

pub fn overwrite_serialized<C: SerializedCollection>(
    id: C::PrimaryKey,
    contents: &C::Contents
) -> Result<Self, Error>

Overwrites a document with the serialized representation of contents in collection. If a document with id exists, it will be overwritten. If a document with id doesn’t exist, it will be created.

pub const fn delete(collection: CollectionName, header: Header) -> Self

Deletes a document from a collection.

Trait Implementations

impl Clone for Operation

fn clone(&self) -> Operation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Operation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Operation

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

Deserialize this value from the given Serde deserializer.

impl From<Operation> for Transaction

fn from(operation: Operation) -> Self

Performs the conversion.

impl Serialize for Operation

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

Serialize this value into the given Serde serializer.