Module artichoke::prelude

source ·
Expand description

A “prelude” for users of the artichoke crate.

This prelude is similar to the standard library’s prelude in that you’ll almost always want to import its entire contents, but unlike the standard library’s prelude, you’ll have to do so manually:

use artichoke::prelude::*;

The prelude may grow over time as additional items see ubiquitous use.


  • Error types for Ruby exceptions and unwinding support.




  • Define and store class specs on an interpreter.
  • Coerce Ruby values to native numerics (floats and integers).
  • Infallible conversion between two types.
  • Mutable infallible conversion between two types.
  • Debugging and Exception message support.
  • Define constants on an interpreter.
  • Execute code and retrieve its result.
  • Rust extension hook that can be required.
  • Get and set global variables on an interpreter.
  • A trait for retrieving an interpreter-global BuildHasher.
  • Store and retrieve byte strings that have the same lifetime as the interpreter.
  • Perform I/O external to the interpreter.
  • Load Ruby sources and Rust extensions into an interpreter.
  • Define and store module specs on an interpreter.
  • Garbage collection primitives for an mruby interpreter.
  • Manage parser state, active filename context, and line number metadata.
  • Interpreter global pseudorandom number generator (PRNG).
  • Track the state of Regexp special global variables and global interpreter state.
  • Polymorphic exception type that corresponds to Ruby’s Exception.
  • Return a Value-wrapped reference to top self.
  • Fallible conversions between two types.
  • Mutable fallible conversions between two types.
  • A boxed Ruby value owned by the interpreter.
  • Emit warnings during interpreter execution to stderr.