Struct MutateInSpec 

#[non_exhaustive]
pub struct MutateInSpec {
    pub op: MutateInOpType,
    pub path: String,
    pub value: Vec<u8>,
    pub create_path: bool,
    pub is_xattr: bool,
    pub expand_macros: bool,
}

A sub-document mutation specification, used with Collection::mutate_in.

Create specs using the static constructors such as insert, upsert, replace, remove, array_append, array_prepend, array_insert, array_add_unique, increment, and decrement.

Example

use couchbase::subdoc::mutate_in_specs::MutateInSpec;

let specs = vec![
    MutateInSpec::upsert("name", "Alice", None).unwrap(),
    MutateInSpec::remove("temp", None),
];

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.

op: MutateInOpType

The type of mutation operation.

path: String

The JSON path to mutate.

value: Vec<u8>

The serialized value to write (empty for remove operations).

create_path: bool

Whether to create intermediate path elements if they don’t exist.

is_xattr: bool

Whether this operation targets an extended attribute (xattr).

expand_macros: bool

Whether server-side macro expansion should be applied.

Implementations

impl MutateInSpec

pub fn insert<V: Serialize>( path: impl Into<String>, value: V, opts: impl Into<Option<InsertSpecOptions>>, ) -> Result<Self>

Creates an insert mutation spec that inserts a value at the given path.

Fails if the path already exists. The value is serialized to JSON via serde.

pub fn insert_raw( path: impl Into<String>, value: Vec<u8>, opts: impl Into<Option<InsertSpecOptions>>, ) -> Self

Creates an insert mutation spec with pre-encoded raw bytes.

pub fn upsert<V: Serialize>( path: impl Into<String>, value: V, opts: impl Into<Option<UpsertSpecOptions>>, ) -> Result<Self>

Creates an upsert mutation spec that sets the value at the given path, creating or overwriting it.

pub fn upsert_raw( path: impl Into<String>, value: Vec<u8>, opts: impl Into<Option<UpsertSpecOptions>>, ) -> Self

Creates an upsert mutation spec with pre-encoded raw bytes.

pub fn replace<V: Serialize>( path: impl Into<String>, value: V, opts: impl Into<Option<ReplaceSpecOptions>>, ) -> Result<Self>

Creates a replace mutation spec that replaces the value at the given path.

Fails if the path does not exist.

pub fn replace_raw( path: impl Into<String>, value: Vec<u8>, opts: impl Into<Option<ReplaceSpecOptions>>, ) -> Self

Creates a replace mutation spec with pre-encoded raw bytes.

pub fn remove( path: impl Into<String>, opts: impl Into<Option<RemoveSpecOptions>>, ) -> Self

Creates a remove mutation spec that removes the value at the given path.

pub fn array_append<V: Serialize>( path: impl Into<String>, value: &[V], opts: impl Into<Option<ArrayAppendSpecOptions>>, ) -> Result<Self>

Appends one or more values to the end of an array at the given path.

pub fn array_append_raw( path: impl Into<String>, value: Vec<u8>, opts: impl Into<Option<ArrayAppendSpecOptions>>, ) -> Self

Appends raw bytes to the end of an array at the given path.

pub fn array_prepend<V: Serialize>( path: impl Into<String>, value: &[V], opts: impl Into<Option<ArrayPrependSpecOptions>>, ) -> Result<Self>

Prepends one or more values to the beginning of an array at the given path.

pub fn array_prepend_raw( path: impl Into<String>, value: Vec<u8>, opts: impl Into<Option<ArrayPrependSpecOptions>>, ) -> Self

Prepends raw bytes to the beginning of an array at the given path.

pub fn array_insert<V: Serialize>( path: impl Into<String>, value: &[V], opts: impl Into<Option<ArrayInsertSpecOptions>>, ) -> Result<Self>

Inserts one or more values at a specific position in an array.

The path must include the array index, e.g. "tags[2]".

pub fn array_insert_raw( path: impl Into<String>, value: Vec<u8>, opts: impl Into<Option<ArrayInsertSpecOptions>>, ) -> Self

Inserts raw bytes at a specific position in an array.

pub fn array_add_unique<V: Serialize>( path: impl Into<String>, value: V, opts: impl Into<Option<ArrayAddUniqueSpecOptions>>, ) -> Result<Self>

Adds a unique value to an array at the given path (no-op if it already exists).

pub fn array_add_unique_raw( path: impl Into<String>, value: Vec<u8>, opts: impl Into<Option<ArrayAddUniqueSpecOptions>>, ) -> Self

Adds raw bytes as a unique value to an array at the given path.

pub fn increment( path: impl Into<String>, delta: i64, opts: impl Into<Option<IncrementSpecOptions>>, ) -> Result<Self>

Increments a numeric value at the given path by the specified positive delta.

Returns an error if delta is negative.

pub fn decrement( path: impl Into<String>, delta: i64, opts: impl Into<Option<DecrementSpecOptions>>, ) -> Result<Self>

Decrements a numeric value at the given path by the specified positive delta.

Returns an error if delta is negative.

Trait Implementations

impl Clone for MutateInSpec

fn clone(&self) -> MutateInSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MutateInSpec

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

Formats the value using the given formatter.

impl PartialEq for MutateInSpec

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

fn is_xattr_op(&self) -> bool

impl<'a> TryFrom<&'a MutateInSpec> for MutateInOp<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &'a MutateInSpec) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for MutateInSpec

impl StructuralPartialEq for MutateInSpec