Struct glsp::GError

pub struct GError { /* fields omitted */ }

The error type generated by GameLisp code.

GResult<T> is an alias for Result<T, GError>.

The easiest way to generate an error yourself is by using one of the macros bail!, ensure! or error!.

The macro-no-op signal is represented by a special kind of GError which is not caught by try or try-verbose. This means that in order to trigger a macro_no_op!, the enclosing function must return GResult<T>.

The with_source method can be used to chain together two GErrors, or to chain an arbitrary Error type onto a GError.

Implementations

impl GError

pub fn new() -> GError

pub fn from_str(st: &str) -> GError

pub fn from_val<T>(t: T) -> GError where
    T: IntoVal, 

pub fn macro_no_op() -> GError

pub fn is_macro_no_op(&self) -> bool

Returns true if this error was generated using macro_no_op! or GError::macro_no_op.

pub fn val(&self) -> Val

Returns the error's payload. Panics if this error is a macro-no-op.

pub fn stack_trace(&self) -> Option<&str>

Returns the error's saved stack trace.

Errors invoked in a dynamic context where verbose errors are disabled (for example, the dynamic scope of a try form) will not have a stack trace.

pub fn with_source(self, source_to_add: impl Error + 'static) -> GError

Chains another error onto this GError.

This can be used to wrap arbitrary Error types in a GError.

let words = match fs::read_to_string("words.txt") {
	Ok(words) => words,
	Err(fs_err) => {
		return Err(error!("failed to open words.txt").with_source(fs_err))
	}
};

Trait Implementations

impl Debug for GError

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

Formats the value using the given formatter.

impl Display for GError

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

Formats the value using the given formatter.

impl Error for GError

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

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

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

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

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

pub fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

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

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting