Struct StimError 

pub struct StimError { /* private fields */ }

An error produced by the Stim library.

This is the unified error type for all fallible operations in the stim crate. It wraps a human-readable message string describing what went wrong.

Most functions and methods in this crate return Result<T>, which is an alias for std::result::Result<T, StimError>. When an operation fails – for example because a circuit contains an invalid gate name, a target index is out of range, a file cannot be read, or a stabilizer operation is mathematically invalid – the error message explains the cause.

StimError implements the standard Error trait, so it integrates smoothly with the Rust error-handling ecosystem (including anyhow, eyre, and the ? operator). It also converts automatically from C++ exceptions raised by the underlying Stim C++ library via the From<cxx::Exception> implementation.

Examples

let err = stim::StimError::new("invalid circuit syntax");
assert_eq!(err.message(), "invalid circuit syntax");
assert_eq!(err.to_string(), "invalid circuit syntax");

// StimError implements std::error::Error.
let dyn_err: Box<dyn std::error::Error> = Box::new(err);
assert_eq!(dyn_err.to_string(), "invalid circuit syntax");

Implementations

impl StimError

pub fn new(message: impl Into<String>) -> Self

Creates a new error with the given message.

The message should describe what went wrong in a way that helps the caller understand how to fix the problem. It will be displayed by the Display implementation and returned by message.

pub fn message(&self) -> &str

Returns the human-readable error message.

This is the same string that was passed to new and that is displayed by the Display implementation.

Trait Implementations

impl Clone for StimError

fn clone(&self) -> StimError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StimError

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

Formats the value using the given formatter.

impl Display for StimError

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

Formats the value using the given formatter.

impl Error for StimError

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<Exception> for StimError

fn from(value: Exception) -> Self

Converts to this type from the input type.

impl PartialEq for StimError

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

impl StructuralPartialEq for StimError