Struct gluon_vm::thread::Thread [−][src]
pub struct Thread { /* fields omitted */ }
Representation of the virtual machine
Methods
impl Thread
[src]
impl Thread
pub fn new_thread(&self) -> Result<RootedThread>
[src]
pub fn new_thread(&self) -> Result<RootedThread>
Spawns a new gluon thread with its own stack and heap but while still sharing the same global environment
pub fn root_thread(&self) -> RootedThread
[src]
pub fn root_thread(&self) -> RootedThread
Roots self
, extending the lifetime of this thread until at least the returned
RootedThread
is droppped
pub fn define_global<'vm, T>(&'vm self, name: &str, value: T) -> Result<()> where
T: Pushable<'vm> + VmType,
[src]
pub fn define_global<'vm, T>(&'vm self, name: &str, value: T) -> Result<()> where
T: Pushable<'vm> + VmType,
: Use gluon::import::add_extern_module
instead
Creates a new global value at name
.
Fails if a global called name
already exists.
Examples
Load the factorial
rust function into gluon and evaluate factorial 5
fn factorial(x: i32) -> i32 { if x <= 1 { 1 } else { x * factorial(x - 1) } } let vm = new_vm(); vm.define_global("factorial", primitive!(1 factorial)).unwrap(); let result = Compiler::new() .run_expr_async::<i32>(&vm, "example", "factorial 5") .sync_or_error() .unwrap_or_else(|err| panic!("{}", err)); let expected = (120, Type::int()); assert_eq!(result, expected);
pub fn get_global<'vm, T>(&'vm self, name: &str) -> Result<T> where
T: Getable<'vm> + VmType,
[src]
pub fn get_global<'vm, T>(&'vm self, name: &str) -> Result<T> where
T: Getable<'vm> + VmType,
Retrieves the global called name
.
Examples
Bind the (+)
function in gluon's prelude standard library
to an add
function in rust
let vm = new_vm(); Compiler::new() .run_expr::<OpaqueValue<&Thread, Hole>>(&vm, "example", r#" import! std.int "#) .unwrap_or_else(|err| panic!("{}", err)); let mut add: FunctionRef<fn(i32, i32) -> i32> = vm.get_global("std.int.num.(+)").unwrap(); let result = add.call(1, 2); assert_eq!(result, Ok(3));
Errors
if the global does not exist or it does not have the correct type.
pub fn find_type_info(&self, name: &str) -> Result<Alias<Symbol, ArcType>>
[src]
pub fn find_type_info(&self, name: &str) -> Result<Alias<Symbol, ArcType>>
Retrieves type information about the type name
. Types inside records can be accessed
using dot notation (std.prelude.Option)
pub fn get_type<T: ?Sized + Any>(&self) -> Option<ArcType>
[src]
pub fn get_type<T: ?Sized + Any>(&self) -> Option<ArcType>
Returns the gluon type that was bound to T
pub fn register_type<T: ?Sized + Any>(
&self,
name: &str,
args: &[&str]
) -> Result<ArcType>
[src]
pub fn register_type<T: ?Sized + Any>(
&self,
name: &str,
args: &[&str]
) -> Result<ArcType>
Registers the type T
as being a gluon type called name
with generic arguments args
pub fn register_type_as(
&self,
name: Symbol,
alias: Alias<Symbol, ArcType>,
id: TypeId
) -> Result<ArcType>
[src]
pub fn register_type_as(
&self,
name: Symbol,
alias: Alias<Symbol, ArcType>,
id: TypeId
) -> Result<ArcType>
pub fn get_env<'b>(&'b self) -> RwLockReadGuard<'b, VmEnv>
[src]
pub fn get_env<'b>(&'b self) -> RwLockReadGuard<'b, VmEnv>
Locks and retrieves the global environment of the vm
pub fn get_macros(&self) -> &MacroEnv
[src]
pub fn get_macros(&self) -> &MacroEnv
Retrieves the macros defined for this vm
pub fn get_event_loop(&self) -> Option<Remote>
[src]
pub fn get_event_loop(&self) -> Option<Remote>
pub fn collect(&self)
[src]
pub fn collect(&self)
Runs a garbage collection.
pub fn push<'vm, T>(&'vm self, v: T) -> Result<()> where
T: Pushable<'vm>,
[src]
pub fn push<'vm, T>(&'vm self, v: T) -> Result<()> where
T: Pushable<'vm>,
Pushes a value to the top of the stack
pub fn pop(&self)
[src]
pub fn pop(&self)
Removes the top value from the stack
pub fn set_memory_limit(&self, memory_limit: usize)
[src]
pub fn set_memory_limit(&self, memory_limit: usize)
pub fn interrupt(&self)
[src]
pub fn interrupt(&self)
pub fn interrupted(&self) -> bool
[src]
pub fn interrupted(&self) -> bool
Trait Implementations
impl Debug for Thread
[src]
impl Debug for Thread
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl Userdata for Thread
[src]
impl Userdata for Thread
impl VmType for Thread
[src]
impl VmType for Thread
type Type = Self
A version of Self
which implements Any
allowing a TypeId
to be retrieved
fn make_forall_type(vm: &Thread) -> ArcType
[src]
fn make_forall_type(vm: &Thread) -> ArcType
fn make_type(vm: &Thread) -> ArcType
[src]
fn make_type(vm: &Thread) -> ArcType
Creates an gluon type which maps to Self
in rust
fn extra_args() -> VmIndex
[src]
fn extra_args() -> VmIndex
How many extra arguments a function returning this type requires. Used for abstract types which when used in return position should act like they still need more arguments before they are called Read more
impl Traverseable for Thread
[src]
impl Traverseable for Thread
impl PartialEq for Thread
[src]
impl PartialEq for Thread
fn eq(&self, other: &Thread) -> bool
[src]
fn eq(&self, other: &Thread) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
fn ne(&self, other: &Rhs) -> bool
This method tests for !=
.
impl<'a> VmRoot<'a> for &'a Thread
[src]
impl<'a> VmRoot<'a> for &'a Thread
fn root(thread: &'a Thread) -> Self
[src]
fn root(thread: &'a Thread) -> Self
fn root_value_with_self(self, value: Value) -> RootedValue<Self>
[src]
fn root_value_with_self(self, value: Value) -> RootedValue<Self>
Roots a value
impl ThreadInternal for Thread
[src]
impl ThreadInternal for Thread
fn context(&self) -> OwnedContext
[src]
fn context(&self) -> OwnedContext
Locks and retrives this threads stack
fn root<'vm, T: Userdata>(
&'vm self,
v: GcPtr<Box<Userdata>>
) -> Option<Root<'vm, T>>
[src]
fn root<'vm, T: Userdata>(
&'vm self,
v: GcPtr<Box<Userdata>>
) -> Option<Root<'vm, T>>
Roots a userdata
fn root_string<'vm>(&'vm self, ptr: GcStr) -> RootStr<'vm>
[src]
fn root_string<'vm>(&'vm self, ptr: GcStr) -> RootStr<'vm>
Roots a string
fn root_value<'vm, T>(&'vm self, value: Value) -> RootedValue<T> where
T: VmRoot<'vm>,
[src]
fn root_value<'vm, T>(&'vm self, value: Value) -> RootedValue<T> where
T: VmRoot<'vm>,
Roots a value
fn call_thunk(
&self,
closure: GcPtr<ClosureData>
) -> FutureValue<Execute<&Thread>>
[src]
fn call_thunk(
&self,
closure: GcPtr<ClosureData>
) -> FutureValue<Execute<&Thread>>
Evaluates a zero argument function (a thunk)
fn execute_io(&self, value: Value) -> FutureValue<Execute<&Self>>
[src]
fn execute_io(&self, value: Value) -> FutureValue<Execute<&Self>>
Calls a module, allowed to to run IO expressions
fn call_function<'b>(
&'b self,
context: OwnedContext<'b>,
args: VmIndex
) -> Result<Async<Option<OwnedContext<'b>>>>
[src]
fn call_function<'b>(
&'b self,
context: OwnedContext<'b>,
args: VmIndex
) -> Result<Async<Option<OwnedContext<'b>>>>
Calls a function on the stack.
When this function is called it is expected that the function exists at
stack.len() - args - 1
and that the arguments are of the correct type
fn resume(&self) -> Result<Async<OwnedContext>>
[src]
fn resume(&self) -> Result<Async<OwnedContext>>
fn global_env(&self) -> &Arc<GlobalVmState>
[src]
fn global_env(&self) -> &Arc<GlobalVmState>
fn set_global(
&self,
name: Symbol,
typ: ArcType,
metadata: Metadata,
value: Value
) -> Result<()>
[src]
fn set_global(
&self,
name: Symbol,
typ: ArcType,
metadata: Metadata,
value: Value
) -> Result<()>
fn deep_clone_value(&self, owner: &Thread, value: Value) -> Result<Value>
[src]
fn deep_clone_value(&self, owner: &Thread, value: Value) -> Result<Value>
owner
is theread that owns value
which is not necessarily the same as self