Enum bonsaidb::core::transaction::Command[][src]

pub enum Command {
    Insert {
        id: Option<DocumentId>,
        contents: Bytes,
    },
    Update {
        header: Header,
        contents: Bytes,
    },
    Overwrite {
        id: DocumentId,
        contents: Bytes,
    },
    Delete {
        header: Header,
    },
}
Expand description

A command to execute within a Collection.

Variants

Insert

Fields

id: Option<DocumentId>

An optional id for the document. If this is None, a unique id will be generated. If this is Some() and a document already exists with that id, a conflict error will be returned.

contents: Bytes

The initial contents of the document.

Inserts a new document containing contents.

Update

Fields

header: Header

The header of the Document. The revision must match the current document.

contents: Bytes

The new contents to store within the Document.

Update an existing Document identified by header. header.revision must match the currently stored revision on the Document. If it does not, the command fill fail with a DocumentConflict error.

Overwrite

Fields

id: DocumentId

The id of the document to overwrite.

contents: Bytes

The new contents to store within the Document.

Overwrite an existing Document identified by id. The revision will not be checked before the document is updated. If the document does not exist, it will be created.

Delete

Fields

header: Header

The current header of the Document.

Delete an existing Document identified by id. revision must match the currently stored revision on the Document. If it does not, the command fill fail with a DocumentConflict error.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Deserialize this value from the given Serde deserializer. Read more

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Performs the conversion.

The alignment of pointer.

The type for initializers.

Initializes a with the given initializer. Read more

Dereferences the given pointer. Read more

Mutably dereferences the given pointer. Read more

Drops the object pointed to by the given pointer. Read more

Should always be Self

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

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

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more