Struct grid_sdk::error::InvalidStateError

pub struct InvalidStateError { /* fields omitted */ }

An error returned when an operation cannot be completed because the state of the underlying struct is inconsistent.

This can be caused by a caller when a sequence of functions is called in a way that results in a state which is inconsistent.

This usually indicates a programming error on behalf of the caller.

Implementations

impl InvalidStateError

pub fn with_message(message: String) -> Self

Constructs a new InvalidStateError with a specified message string.

The implementation of std::fmt::Display for this error will be the message string provided.

Examples

use grid_sdk::error::InvalidStateError;

let invalid_state_error = InvalidStateError::with_message("oops".to_string());
assert_eq!(format!("{}", invalid_state_error), "oops");

Trait Implementations

impl Debug for InvalidStateError

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

Formats the value using the given formatter.

impl Display for InvalidStateError

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

Formats the value using the given formatter.

impl Error for InvalidStateError

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

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

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

Returns a stack backtrace, if available, of where this error occurred.

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