Expand description
Runtime module for Rune.
Re-exports§
pub use self::debug::DebugInfo;
pub use self::debug::DebugInst;
pub use self::format::Format;
pub use self::format::FormatSpec;
pub use self::unit::Unit;
pub use self::unit::UnitStorage;
pub use self::value::Accessor;
pub use self::value::TypeValue;
pub use self::vm_error::try_result;
pub use self::vm_error::TryFromResult;
Modules§
- budget
- Budgeting module for Runestick.
- debug
- Debug information for units.
- format
- Types for dealing with formatting specifications.
- slice
- Types for working with slices.
- unit
- A single execution unit in the rune virtual machine.
Structs§
- Access
Error - An error raised when failing to access a value.
- AnyObj
- A type-erased wrapper for a reference, whether it is mutable or not.
- AnyObj
Error - Errors caused when accessing or coercing an
AnyObj
. - AnyType
Info - Type information for the
Any
type. - Borrow
Mut - Guard for data exclusively borrowed from a slot in the virtual machine.
- Borrow
Ref - Guard for a data borrowed from a slot in the virtual machine.
- Bytes
- A vector of bytes.
- Call
Frame - A call frame.
- Const
Value - A constant value.
- Debug
Label - A label that can be jumped to.
- Dynamic
Empty - A reference to a dynamically defined empty type.
- Dynamic
Struct - A reference to a dynamically defined struct.
- Dynamic
Tuple - A reference to a dynamically defined tuple.
- Empty
Struct - A empty with a well-defined type.
- Formatter
- A formatter for the rune virtual machine.
- Function
- The type of a function in Rune.
- Future
- A type-erased future that can only be unsafely polled in combination with the virtual machine that created it.
- Generator
- A generator produced by a generator function.
- Hasher
- The default hasher used in Rune.
- Inst
Address - How an instruction addresses a value.
- Iterator
- An owning iterator.
- Mut
- A strong owned mutable reference to the given type that can be safely dereferenced.
- Object
- Struct representing a dynamic anonymous object.
- Output
- What to do with the output of an instruction.
- Owned
Tuple - Struct representing a dynamic anonymous object.
- Protocol
- A built in instance function.
- Range
- Type for a range expression
start..end
. - Range
From - Type for a from range expression
start..
. - Range
Full - Type for a full range expression
..
. - Range
Inclusive - Type for an inclusive range expression
start..=end
. - RangeTo
- Type for an inclusive range expression
..end
. - Range
ToInclusive - Type for an inclusive range expression
..=end
. - RawAny
Guard - A raw guard for a
Ref
or aMut
that has been converted into its raw components throughRef::into_raw
orMut::into_raw
. - RawValue
Guard - The guard returned by Value::into_any_mut_ptr.
- Ref
- A strong owned reference to the given type that can be safely dereferenced.
- Rtti
- Runtime information on variant.
- Runtime
Context - Static run context visible to the virtual machine.
- Runtime
Error - An opaque simple runtime error.
- Slice
Error - An error raised when accessing a slice on the stack.
- Stack
- The stack of the virtual machine, where all values are stored.
- Stack
Error - An error raised when accessing an address on the stack.
- Static
String - Struct representing a static string.
- Stream
- A stream produced by an async generator function.
- Struct
- An object with a well-defined type.
- Sync
Function - A callable sync function. This currently only supports a subset of values that are supported by the Vm.
- Tuple
- The type of a tuple slice.
- Tuple
Struct - A tuple with a well-defined type.
- Type
- A value representing a type in the virtual machine.
- Type
Info - Diagnostical type information for a given type.
- Value
- An entry on the stack.
- Value
MutGuard - Defined guard for a reference value.
- Value
RefGuard - Defined guard for a reference value.
- Vec
- Struct representing a dynamic vector.
- VecTuple
- A helper type to deserialize arrays with different interior types.
- Vm
- A stack which references variables indirectly from a slab.
- VmError
- A virtual machine error which includes tracing information.
- VmExecution
- The execution environment for a virtual machine.
- VmSend
Execution - A wrapper that makes
VmExecution
Send
.
Enums§
- Call
- The calling convention of a function.
- Control
Flow - Used to tell an operation whether it should exit early or go on as usual.
- Generator
State - The state of a generator.
- Inline
- An inline value.
- Inst
- An operation in the stack-based virtual machine.
- Inst
Arithmetic Op - An operation between two values on the machine.
- Inst
Bitwise Op - An operation between two values on the machine.
- InstOp
- An operation between two values on the machine.
- Inst
Range - Range limits of a range expression.
- Inst
Shift Op - An operation between two values on the machine.
- Inst
Target - The target of an operation.
- Inst
Value - A literal value that can be pushed.
- Inst
Variant - A variant that can be constructed.
- Isolated
- Indicating the kind of isolation that is present for a frame.
- Panic
Reason - Pre-canned panic reasons.
- Type
Check - Type checks for built-in types.
- VmResult
- A result produced by the virtual machine.
Traits§
- Args
- Trait for converting arguments onto the stack.
- Const
Construct - Implementation of a constant constructor.
- Fixed
Args - Trait for converting arguments into an array.
- From
Const Value - Convert a value from a constant value.
- From
Value - Trait for converting types from the dynamic Value container.
- Guarded
Args - Trait for converting arguments onto the stack.
- Into
Output - Trait used to coerce values into outputs.
- Maybe
Type Of - A type that might or might not have a concrete type.
- Memory
- Memory access.
- ToConst
Value - Convert a value into a constant value.
- ToReturn
- Trait governing things that can be returned from native functions.
- ToValue
- Trait for converting types into the dynamic
Value
container. - Type
Hash - Static type hash for a given type.
- TypeOf
- Trait used for Rust types for which we can determine the runtime type of.
- Unsafe
From Value Deprecated - A potentially unsafe conversion for value conversion.
- Unsafe
ToMut - Unsafe to mut coercion.
- Unsafe
ToRef - Unsafe to ref coercion.
- Unsafe
ToValue - Trait for converting types into values.
Functions§
- bytes_
slice_ index_ get - This is a common index get implementation that is helpfull for custom type to impl
INDEX_GET
protocol. - from_
const_ value - Convert something into a
ConstValue
. - from_
value - Convert something into the dynamic
Value
. - to_
const_ value - Convert something into a
ConstValue
. - to_
value - Convert something into the dynamic
Value
.
Derive Macros§
- From
Value - Derive macro for the
FromValue
trait for converting types from the dynamicValue
container. - ToConst
Value - Derive for the
ToConstValue
trait. - ToValue
- Derive macro for the
ToValue
trait for converting types into the dynamicValue
container.