Struct GXHandle 

pub struct GXHandle<X: GXExt>(/* private fields */);

A handle to a running GX instance.

Drop the handle to shutdown the associated background tasks.

Implementations

impl<X: GXExt> GXHandle<X>

pub async fn get_env(&self) -> Result<Env<GXRt<X>, X::UserEvent>>

Get a copy of the current graphix environment

pub async fn check(&self, path: PathBuf) -> Result<()>

Check that the specified file compiles and typechecks.

If the file will compile and type check successfully return Ok(()) otherwise an error describing the problem. The environment will not be altered by checking an expression, so you will not be able to use any defined names later in the program. If you want to do that see compile

pub async fn compile(&self, text: ArcStr) -> Result<CompRes<X>>

Compile and execute the specified graphix expression.

If it generates results, they will be sent to all the channels that are subscribed. When the CompExp objects contained in the CompRes are dropped their corresponding expressions will be deleted. Therefore, you can stop execution of the whole expression by dropping the returned CompRes.

pub async fn load(&self, path: PathBuf) -> Result<CompRes<X>>

Load and execute the specified graphix module.

The path may have one of two forms. If it is the path to a file with extension .bs then the rt will load the file directly. If it is a modpath (e.g. foo::bar::baz) then the module resolver will look for a matching module in the modpath. When the CompExp objects contained in the CompRes are dropped their corresponding expressions will be deleted. Therefore, you can stop execution of the whole file by dropping the returned CompRes.

pub async fn compile_callable(&self, id: Value) -> Result<Callable<X>>

Compile a callable interface to the specified lambda id.

This is how you call a lambda directly from rust. When the returned Callable is dropped the associated callsite will be delete.

pub async fn compile_callable_by_name( &self, env: &Env<GXRt<X>, X::UserEvent>, scope: &Scope, name: &ModPath, ) -> Result<NamedCallable<X>>

Compile a callable interface to a late bound function by name.

This allows you to call a function by name. Because of late binding it has some additional complexity (though less than implementing it yourself). You must call update on NamedCallable when you recieve updates from the runtime in order to drive late binding. update will also return Some when one of your function calls returns.

pub async fn compile_ref(&self, id: impl Into<BindId>) -> Result<Ref<X>>

Compile a ref to a specific bind id

This will NOT return an error if the specified id isn’t in the environment.

pub async fn compile_ref_by_name( &self, env: &Env<GXRt<X>, X::UserEvent>, scope: &Scope, name: &ModPath, ) -> Result<Ref<X>>

Compile a ref to a specific name

Return an error if the name does not exist in the specified environment

pub fn set<T: Into<Value>>(&self, id: BindId, v: T) -> Result<()>

Set the variable idenfified by id to v

triggering updates of all dependent node trees. This does the same thing asRef::set and TRef::set

Trait Implementations

impl<X: GXExt> Clone for GXHandle<X>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<X: GXExt> Debug for GXHandle<X>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.