Struct Error 

pub struct Error {
    pub kind: ErrorKind,
    pub context: Option<String>,
}

Error type for Automorph operations.

This error is returned when synchronization fails, typically due to:

• Type mismatches between the Rust struct and Automerge document
• Missing required fields
• Invalid data in the Automerge document

Example

use automorph::{Automorph, Error};
use automerge::{AutoCommit, ROOT};

let doc = AutoCommit::new();
// Trying to read a String from an empty document fails
let result = String::load(&doc, &ROOT, "missing");
assert!(result.is_err());

Fields

kind: ErrorKind

The kind of error that occurred.

context: Option<String>

Additional context about where the error occurred.

Implementations

impl Error

pub fn type_mismatch(expected: &'static str, found: Option<String>) -> Self

Creates a new type mismatch error.

pub fn missing_field(field: impl Into<String>) -> Self

Creates a new missing field error.

pub fn missing_value() -> Self

Creates a new missing value error.

pub fn invalid_value(reason: impl Into<String>) -> Self

Creates a new invalid value error.

pub fn expected_type(expected: &'static str, type_name: &str) -> Self

Creates a type mismatch error for expected struct type.

pub fn unknown_field(field: impl Into<String>) -> Self

Creates an unknown field error.

pub fn with_context(self, context: impl Into<String>) -> Self

Adds context to this error.

pub fn with_field(self, field: impl Into<String>) -> Self

Prepends a field name to the existing context path.

This is useful for building up paths like “person.address.city” when errors bubble up through nested structures.

Example

use automorph::Error;

let err = Error::missing_value()
    .with_field("city")
    .with_field("address")
    .with_field("person");
// Error message will show: "at person.address.city"

pub fn with_index(self, index: usize) -> Self

Prepends an array index to the existing context path.

Example

use automorph::Error;

let err = Error::missing_value()
    .with_index(2)
    .with_field("items");
// Error message will show: "at items[2]"

pub fn is_missing_value(&self) -> bool

Returns true if this error is a missing value error.

pub fn is_missing_field(&self) -> bool

Returns true if this error is a missing field error.

pub fn is_type_mismatch(&self) -> bool

Returns true if this error is a type mismatch error.

pub fn is_unknown_field(&self) -> bool

Returns true if this error is an unknown field error.

pub fn is_invalid_value(&self) -> bool

Returns true if this error is an invalid value error.

pub fn is_automerge(&self) -> bool

Returns true if this error is an Automerge error.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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 From<AutomergeError> for Error

fn from(err: AutomergeError) -> Self

Converts to this type from the input type.