Struct ShellBuilder 

pub struct ShellBuilder<X: GXExt> { /* private fields */ }

Builder for Shell.

Implementations

impl<X: GXExt> ShellBuilder<X>

pub fn no_init(self, value: bool) -> Self

do not run the users init module

pub fn publish_timeout(self, value: Duration) -> Self

drop subscribers if they don’t consume updates after this timeout

pub fn resolve_timeout(self, value: Duration) -> Self

module resolution from netidx will fail if it can’t subscribe before this time elapses

pub fn module_resolvers(self, value: Vec<ModuleResolver>) -> Self

define module resolvers to append to the default list

pub fn stdlib_modules(self, value: BitFlags<Module>) -> Self

enable or disable features of the standard library

pub fn mode(self, value: Mode) -> Self

set the shell’s mode

pub fn publisher(self, value: Publisher) -> Self

The netidx publisher to use. If you do not wish to use netidx you can use netidx::InternalOnly to create an internal netidx environment

pub fn subscriber(self, value: Subscriber) -> Self

The netidx subscriber to use. If you do not wish to use netidx you can use netidx::InternalOnly to create an internal netidx environment

pub fn register( self, value: Arc<dyn Fn(&mut ExecCtx<GXRt<X>, X::UserEvent>) -> ArcStr>, ) -> Self

Provide a closure to register any built-ins you wish to use.

Your closure should register the builtins with the context and return a string specifiying any modules you need to load in order to use them. For example if you wish to implement a module called m containing builtins foo and bar, then you would first implement foo and bar in rust and register them with the context. You would add a VFS module resolver to the set of resolvers containing prototypes that reference your rust builtins. e.g.

pub let foo = |x, y| 'foo_builtin;
pub let bar = |x| 'bar_builtin

Your VFS resolver would map “/m” -> the above stubs. Your register function would then return “mod m\n” to force loading the module at startup. Then your user only needs to use m

pub fn build(self) -> Result<Shell<X>, ShellBuilderError>

Builds a new Shell.

Errors

If a required field has not been initialized.

Trait Implementations

impl<X: GXExt> Default for ShellBuilder<X>

fn default() -> Self

Returns the “default value” for a type.