Enum DataError 

#[non_exhaustive]
pub enum DataError {
    Corrupt(String),
    Poisoned,
    DocTooLarge {
        actual: usize,
        limit: usize,
    },
    ValueTooLarge {
        actual: usize,
        limit: usize,
    },
    InvalidName {
        name: String,
        reason: &'static str,
    },
    InvalidAttachment {
        reason: &'static str,
    },
    OutOfRange {
        position: usize,
        length: usize,
    },
    Engine(String),
}

A failure inside the replicated-document layer.

Every variant is either a caller mistake (a bad key, an out-of-range position, a document over the cap) or a permanent corruption verdict. Transient conditions do not appear here: persistence retries live above this crate, on the SDK’s storage seam.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Corrupt(String)

A document, snapshot, or delta could not be decoded.

The bytes reaching this crate always come back out of a sealed protocol-state record, so an AEAD tag has already vouched for them. This variant therefore means the engine rejected its own output: treat the document as permanently unreadable rather than retrying.

Poisoned

A document handle was used after a decode panic poisoned it.

Held separate from DataError::Corrupt because the failure is sticky: every later call on the same handle answers this, and the only recovery is to drop the handle and re-open from storage.

DocTooLarge

The compacted document would exceed crate::MAX_DOC_BYTES.

Raised at commit, never as a silent truncation: an application that keeps typing into a full document has to hear about it while the text is still on screen.

Fields

actual: usize

Size of the compacted encoding that breached the cap.

limit: usize

The cap in force, crate::MAX_DOC_BYTES.

ValueTooLarge

A single value is larger than crate::MAX_VALUE_BYTES.

Refused at the operation rather than at commit. A value this size can never fit in a document, and discovering that at commit means the document’s next delta record is unwritable and stays unwritable, because a refused write is re-exported (larger) by the commit after it.

Fields

actual: usize

Size of the rejected value.

limit: usize

The limit in force, crate::MAX_VALUE_BYTES.

InvalidName

A collection or document name is empty, over-long, or uses characters outside the accepted set.

Fields

name: String

The rejected name.

reason: &'static str

Why it was rejected.

InvalidAttachment

An attachment reference is malformed.

Separate from DataError::InvalidName because an attachment hash is not a name the caller chose, it is the address of the bytes. A reference whose hash is not a SHA-256 can never be fetched, and a reference that cannot be fetched is worse than no reference at all: it replicates to every member of the space, and every one of them sees an attachment that will never arrive.

Fields

reason: &'static str

Why it was rejected.

OutOfRange

A list or text position is outside the current length.

Fields

position: usize

The position the caller asked for.

length: usize

The current length of the collection.

Engine(String)

The engine refused an otherwise well-formed operation.

Trait Implementations

impl Debug for DataError

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

Formats the value using the given formatter.

impl Display for DataError

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

Formats the value using the given formatter.

impl Error for DataError

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.