Struct BulkMutationError 

pub struct BulkMutationError<E>
where
    E: Error + Send + 'static,
{ /* private fields */ }

An error which occurred while mutating the state not allowing the operation to proceed any further but also having some part of the operation complete.

Implementations

impl<E> BulkMutationError<E>

where E: Error + Send + 'static,

pub fn empty_with_error(error: E) -> Self

Creates a new mutation error from the provided inner error.

This essentially means that what ever change that was going to happen was atomic and has therefore been revered.

WARNING: You should under no circumstances return an empty mutation error if any part of the state has been mutated and will not be reversed. Doing so will lead to state divergence within the cluster

pub fn new(error: E, successful_doc_ids: Vec<Key>) -> Self

Creates a new mutation error from the provided inner error.

This essentially means that although we ran into an error, we were able to complete some part of the operation on some documents.

WARNING: You should under no circumstances return an empty mutation error if any part of the state has been mutated and will not be reversed. Doing so will lead to state divergence within the cluster

pub fn cause(&self) -> &E

The cause of the error.

pub fn into_inner(self) -> E

Consumes the error returning the inner error.

pub fn successful_doc_ids(&self) -> &[Key]

The document ids which the operation was successful on.

Trait Implementations

impl<E> Debug for BulkMutationError<E>

where E: Error + Send + 'static + Debug,

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

Formats the value using the given formatter.

impl<E> Display for BulkMutationError<E>

where E: Error + Send + 'static + Display,

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

Formats the value using the given formatter.

impl<E> Error for BulkMutationError<E>

where E: Error + Send + 'static, Self: Debug + Display,

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

impl<E: Error + Send + 'static> From<BulkMutationError<E>> for StoreError<E>

fn from(source: BulkMutationError<E>) -> Self

Converts to this type from the input type.