Struct Error

pub struct Error(/* private fields */);

The Error type, a wrapper around a dynamic exception type.

Error works a lot like Box<dyn std::error::Error>, but with these differences:

• Error requires that the error is 'static.
• Error requires that the error implement RubyException.
• Error can convert itself to a backtrace on the underlying Ruby VM.

All types that implement RubyException are able to be converted to 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<ArenaSavepointError> for Error

fn from(exception: ArenaSavepointError) -> Self

Converts to this type from the input type.

impl From<ArgCountError> for Error

fn from(exception: ArgCountError) -> Self

Converts to this type from the input type.

impl From<ArgumentError> for Error

fn from(err: EnvArgumentError) -> Self

Converts to this type from the input type.

impl From<ArgumentError> for Error

fn from(exception: ArgumentError) -> Error

Converts to this type from the input type.

impl From<ArgumentError> for Error

fn from(err: ArgumentError) -> Self

Converts to this type from the input type.

impl From<ArgumentError> for Error

fn from(err: ArgumentError) -> Self

Converts to this type from the input type.

impl From<Box<dyn RubyException>> for Error

fn from(exc: Box<dyn RubyException>) -> Self

Converts to this type from the input type.

impl From<BoxIntoRubyError> for Error

fn from(exception: BoxIntoRubyError) -> Self

Converts to this type from the input type.

impl From<CaughtException> for Error

fn from(exc: CaughtException) -> Self

Converts to this type from the input type.

impl From<ConstantNameError> for Error

fn from(exception: ConstantNameError) -> Self

Converts to this type from the input type.

impl From<ConvertBytesError> for Error

fn from(exception: ConvertBytesError) -> Self

Converts to this type from the input type.

impl From<DomainError> for Error

fn from(exception: DomainError) -> Self

Converts to this type from the input type.

impl From<DomainError> for Error

fn from(err: DomainError) -> Self

Converts to this type from the input type.

impl From<EOFError> for Error

fn from(exception: EOFError) -> Error

Converts to this type from the input type.

impl From<EncodingError> for Error

fn from(exception: EncodingError) -> Error

Converts to this type from the input type.

impl<'a> From<Error<'a>> for Error

fn from(err: Error<'a>) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(err: EnvError) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(err: MathError) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(err: SecureRandomError) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Exception> for Error

fn from(exception: Exception) -> Error

Converts to this type from the input type.

impl From<Fatal> for Error

fn from(exception: Fatal) -> Error

Converts to this type from the input type.

impl From<FiberError> for Error

fn from(exception: FiberError) -> Error

Converts to this type from the input type.

impl From<FloatDomainError> for Error

fn from(exception: FloatDomainError) -> Error

Converts to this type from the input type.

impl From<FrozenError> for Error

fn from(exception: FrozenError) -> Error

Converts to this type from the input type.

impl From<IOError> for Error

fn from(exception: IOError) -> Error

Converts to this type from the input type.

impl From<IncrementLinenoError> for Error

fn from(exception: IncrementLinenoError) -> Self

Converts to this type from the input type.

impl From<IndexError> for Error

fn from(exception: IndexError) -> Error

Converts to this type from the input type.

impl From<InitError> for Error

fn from(err: InitError) -> Self

Converts to this type from the input type.

impl From<InitializeError> for Error

fn from(err: InitializeError) -> Self

Converts to this type from the input type.

impl From<InterpreterExtractError> for Error

fn from(exception: InterpreterExtractError) -> Self

Converts to this type from the input type.

impl From<Interrupt> for Error

fn from(exception: Interrupt) -> Error

Converts to this type from the input type.

impl From<InvalidError> for Error

fn from(err: InvalidError) -> Self

Converts to this type from the input type.

impl From<KeyError> for Error

fn from(exception: KeyError) -> Error

Converts to this type from the input type.

impl From<LoadError> for Error

fn from(exception: LoadError) -> Error

Converts to this type from the input type.

impl From<LocalJumpError> for Error

fn from(exception: LocalJumpError) -> Error

Converts to this type from the input type.

impl From<NameError> for Error

fn from(exception: NameError) -> Error

Converts to this type from the input type.

impl From<NewSeedError> for Error

fn from(err: NewSeedError) -> Self

Converts to this type from the input type.

impl From<NoBlockGiven> for Error

fn from(exception: NoBlockGiven) -> Self

Converts to this type from the input type.

impl From<NoMemoryError> for Error

fn from(exception: NoMemoryError) -> Error

Converts to this type from the input type.

impl From<NoMethodError> for Error

fn from(exception: NoMethodError) -> Error

Converts to this type from the input type.

impl From<NotDefinedError> for Error

fn from(exception: NotDefinedError) -> Self

Converts to this type from the input type.

impl From<NotImplementedError> for Error

fn from(exception: NotImplementedError) -> Error

Converts to this type from the input type.

impl From<NotImplementedError> for Error

fn from(err: MathNotImplementedError) -> Self

Converts to this type from the input type.

impl From<RandomBytesError> for Error

fn from(err: RandomBytesError) -> Self

Converts to this type from the input type.

impl From<RangeError> for Error

fn from(exception: RangeError) -> Error

Converts to this type from the input type.

impl From<RegexpError> for Error

fn from(exception: RegexpError) -> Error

Converts to this type from the input type.

impl From<RuntimeError> for Error

fn from(exception: RuntimeError) -> Error

Converts to this type from the input type.

impl From<ScriptError> for Error

fn from(exception: ScriptError) -> Error

Converts to this type from the input type.

impl From<SecurityError> for Error

fn from(exception: SecurityError) -> Error

Converts to this type from the input type.

impl From<SignalException> for Error

fn from(exception: SignalException) -> Error

Converts to this type from the input type.

impl From<StandardError> for Error

fn from(exception: StandardError) -> Error

Converts to this type from the input type.

impl From<StopIteration> for Error

fn from(exception: StopIteration) -> Error

Converts to this type from the input type.

impl From<SymbolOverflowError> for Error

fn from(exception: SymbolOverflowError) -> Self

Converts to this type from the input type.

impl From<SyntaxError> for Error

fn from(exception: SyntaxError) -> Error

Converts to this type from the input type.

impl From<SystemCallError> for Error

fn from(exception: SystemCallError) -> Error

Converts to this type from the input type.

impl From<SystemExit> for Error

fn from(exception: SystemExit) -> Error

Converts to this type from the input type.

impl From<SystemStackError> for Error

fn from(exception: SystemStackError) -> Error

Converts to this type from the input type.

impl From<ThreadError> for Error

fn from(exception: ThreadError) -> Error

Converts to this type from the input type.

impl From<TimeError> for Error

fn from(error: TimeError) -> Error

Converts to this type from the input type.

impl From<TypeError> for Error

fn from(exception: TypeError) -> Error

Converts to this type from the input type.

impl From<UnboxRubyError> for Error

fn from(exception: UnboxRubyError) -> Self

Converts to this type from the input type.

impl From<UncaughtThrowError> for Error

fn from(exception: UncaughtThrowError) -> Error

Converts to this type from the input type.

impl From<UrandomError> for Error

fn from(err: UrandomError) -> Self

Converts to this type from the input type.

impl From<WriteError> for Error

fn from(exception: WriteError) -> Self

Converts to this type from the input type.

impl From<ZeroDivisionError> for Error

fn from(exception: ZeroDivisionError) -> Error

Converts to this type from the input type.

impl RubyException for Error

fn name(&self) -> Cow<'_, str>

Class name of the Exception.

fn message(&self) -> Cow<'_, [u8]>

Message of the Exception.

fn vm_backtrace(&self, interp: &mut Artichoke) -> Option<Vec<Vec<u8>>>

Optional backtrace specified by a Vec of frames.

fn as_mrb_value(&self, interp: &mut Artichoke) -> Option<mrb_value>

Return a raise-able sys::mrb_value.