Struct bonsaidb_core::transaction::Transaction

pub struct Transaction {
    pub operations: Vec<Operation>,
}

A list of operations to execute as a single unit. If any operation fails, all changes are aborted. Reads that happen while the transaction is in progress will return old data and not block.

Fields

operations: Vec<Operation>

The operations in this transaction.

Implementations

impl Transaction

pub fn new() -> Self

Returns a new, empty transaction.

pub fn push(&mut self, operation: Operation)

Adds an operation to the transaction.

pub fn with(self, operation: Operation) -> Self

Appends an operation to the transaction and returns self.

impl Transaction

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 update(
    collection: CollectionName,
    header: Header,
    contents: impl Into<Bytes>
) -> Self

Updates a document 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 delete(collection: CollectionName, header: Header) -> Self

Deletes a document from a collection.

Trait Implementations

impl Clone for Transaction

fn clone(&self) -> Transaction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Transaction

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

Formats the value using the given formatter.

impl Default for Transaction

fn default() -> Transaction

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Transaction

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 Transaction

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

Serialize this value into the given Serde serializer.