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.
Modules§
- error
- Error types for Ruby exceptions and unwinding support.
Structs§
- Argument
Error - Ruby
ArgumentErrorerror type. - Artichoke
- Interpreter instance.
- EOFError
- Ruby
EOFErrorerror type. - Encoding
Error - Ruby
EncodingErrorerror type. - Error
- The
Errortype, a wrapper around a dynamic exception type. - Exception
- Ruby
Exceptionerror type. - Fatal
- Ruby
fatalerror type. - Fiber
Error - Ruby
FiberErrorerror type. - Float
Domain Error - Ruby
FloatDomainErrorerror type. - Frozen
Error - Ruby
FrozenErrorerror type. - Guard
- Interpreter guard that prepares an
Artichoketo re-enter an FFI boundary. - IOError
- Ruby
IOErrorerror type. - Index
Error - Ruby
IndexErrorerror type. - Interrupt
- Ruby
Interrupterror type. - KeyError
- Ruby
KeyErrorerror type. - Load
Error - Ruby
LoadErrorerror type. - Local
Jump Error - Ruby
LocalJumpErrorerror type. - Name
Error - Ruby
NameErrorerror type. - NoMemory
Error - Ruby
NoMemoryErrorerror type. - NoMethod
Error - Ruby
NoMethodErrorerror type. - NotImplemented
Error - Ruby
NotImplementedErrorerror type. - Range
Error - Ruby
RangeErrorerror type. - Regexp
Error - Ruby
RegexpErrorerror type. - Release
Metadata - Information about an Artichoke build.
- Runtime
Error - Ruby
RuntimeErrorerror type. - Script
Error - Ruby
ScriptErrorerror type. - Security
Error - Ruby
SecurityErrorerror type. - Signal
Exception - Ruby
SignalExceptionerror type. - Standard
Error - Ruby
StandardErrorerror type. - Stop
Iteration - Ruby
StopIterationerror type. - Syntax
Error - Ruby
SyntaxErrorerror type. - System
Call Error - Ruby
SystemCallErrorerror type. - System
Exit - Ruby
SystemExiterror type. - System
Stack Error - Ruby
SystemStackErrorerror type. - Thread
Error - Ruby
ThreadErrorerror type. - Type
Error - Ruby
TypeErrorerror type. - Uncaught
Throw Error - Ruby
UncaughtThrowErrorerror type. - Zero
Division Error - Ruby
ZeroDivisionErrorerror type.
Enums§
- Increment
Lineno Error - Errors encountered when incrementing line numbers on parser state.
- Ruby
- Classes of Ruby types.
- Rust
- Classes of Rust types.
Traits§
- Class
Registry - Define and store class specs on an interpreter.
- Coerce
ToNumeric - Coerce Ruby values to native numerics (floats and integers).
- Convert
- Infallible conversion between two types.
- Convert
Mut - Mutable infallible conversion between two types.
- Debug
- Debugging and
Exceptionmessage support. - Define
Constant - Define constants on an interpreter.
- Eval
- Execute code and retrieve its result.
- File
- Rust extension hook that can be required.
- Globals
- Get and set global variables on an interpreter.
- Hash
- A trait for retrieving an interpreter-global
BuildHasher. - Intern
- Store and retrieve byte strings that have the same lifetime as the interpreter.
- Io
- Perform I/O external to the interpreter.
- Load
Sources - Load Ruby sources and Rust extensions into an interpreter.
- Module
Registry - Define and store module specs on an interpreter.
- MrbGarbage
Collection - Garbage collection primitives for an mruby interpreter.
- Parser
- Manage parser state, active filename context, and line number metadata.
- Prng
- Interpreter global pseudorandom number generator (PRNG).
- Regexp
- Track the state of
Regexpspecial global variables and global interpreter state. - Ruby
Exception - Polymorphic exception type that corresponds to Ruby’s
Exception. - TopSelf
- Return a
Value-wrapped reference to top self. - TryConvert
- Fallible conversions between two types.
- TryConvert
Mut - Mutable fallible conversions between two types.
- Value
- A boxed Ruby value owned by the interpreter.
- Warn
- Emit warnings during interpreter execution to stderr.