Struct BSHandle

pub struct BSHandle(/* private fields */);

A handle to a running BS instance. Drop the handle to shutdown the associated background tasks.

Implementations

impl BSHandle

pub async fn get_env(&self) -> Result<Env<BSCtx, NoUserEvent>>

Get a copy of the current bscript environment

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

Compile and execute the specified bscript expression. It can either be a module expression or a single expression. If it generates results, they will be sent to all the channels that are subscribed.

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

Load and execute the specified bscript 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.

pub async fn delete(&self, id: ExprId) -> Result<Env<BSCtx, NoUserEvent>>

Delete the specified expression

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

Compile a callable interface to the specified lambda id. This is how you call a lambda directly from rust.

pub async fn compile_ref(&self, id: Value) -> Result<ExprId>

Compile an expression that will output the value of the ref specifed by id. This is the same as the deref (*) operator in bscript.

pub fn subscribe(&self, ch: Sender<RtEvent>) -> Result<()>

The specified channel will receive events generated by all bscript expressions being run by the runtime. To unsubscribe, just drop the receiver.

Trait Implementations

impl Clone for BSHandle

fn clone(&self) -> BSHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.