pub struct Engine { /* private fields */ }Expand description
The main Hypen engine that orchestrates reactive UI rendering.
§Architecture: Single Active Module
Each Engine instance has one “active” module at a time for state bindings.
When DSL templates reference ${state.xxx}, they resolve against the active
module’s state.
§Multi-module Applications
Multi-module apps (e.g., AppState + StatsScreen) work as follows:
-
TypeScript SDK layer manages multiple
HypenModuleInstanceobjects, each with its own Proxy-based state tracking. -
Cross-module communication uses
HypenGlobalContext:// In StatsScreen's action handler: const app = context.getModule<AppState>("app"); app.setState({ showStats: true }); -
State binding scope: Each module’s template binds to its own state. You cannot reference another module’s state directly in templates. Use props or callbacks instead:
// StatsScreen receives app data via props, not state binding StatsView(data: @props.appStats)
§Limitation
The engine’s state binding model (${state.xxx}) is scoped to a single module.
Cross-module state access requires explicit prop passing or action dispatching.
This keeps the reactive graph simple but requires careful data flow design.
Implementations§
Source§impl Engine
impl Engine
pub fn new() -> Self
Sourcepub fn register_component(&mut self, component: Component)
pub fn register_component(&mut self, component: Component)
Register a custom component
Sourcepub fn set_component_resolver<F>(&mut self, resolver: F)
pub fn set_component_resolver<F>(&mut self, resolver: F)
Set the component resolver for dynamic component loading The resolver receives (component_name, context_path) and should return ResolvedComponent { source, path } or None
Sourcepub fn set_module(&mut self, module: ModuleInstance)
pub fn set_module(&mut self, module: ModuleInstance)
Set the module instance
Sourcepub fn set_render_callback<F>(&mut self, callback: F)
pub fn set_render_callback<F>(&mut self, callback: F)
Set the render callback
Sourcepub fn on_action<F>(&mut self, action_name: impl Into<String>, handler: F)
pub fn on_action<F>(&mut self, action_name: impl Into<String>, handler: F)
Register an action handler
Sourcepub fn render(&mut self, element: &Element)
pub fn render(&mut self, element: &Element)
Render an element tree (initial render or full re-render)
Sourcepub fn notify_state_change(&mut self, change: &StateChange)
pub fn notify_state_change(&mut self, change: &StateChange)
Handle a state change notification from the module host The host keeps the actual state - we just need to know what changed
Sourcepub fn update_state(&mut self, state_patch: Value)
pub fn update_state(&mut self, state_patch: Value)
Convenience method for backward compatibility / JSON patches
Sourcepub fn dispatch_action(&mut self, action: Action) -> Result<(), EngineError>
pub fn dispatch_action(&mut self, action: Action) -> Result<(), EngineError>
Dispatch an action
Sourcepub fn component_registry(&self) -> &ComponentRegistry
pub fn component_registry(&self) -> &ComponentRegistry
Get access to the component registry
Sourcepub fn component_registry_mut(&mut self) -> &mut ComponentRegistry
pub fn component_registry_mut(&mut self) -> &mut ComponentRegistry
Get mutable access to the component registry
Sourcepub fn resources(&self) -> &ResourceCache
pub fn resources(&self) -> &ResourceCache
Get access to the resource cache
Sourcepub fn resources_mut(&mut self) -> &mut ResourceCache
pub fn resources_mut(&mut self) -> &mut ResourceCache
Get mutable access to the resource cache
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Engine
impl !RefUnwindSafe for Engine
impl Send for Engine
impl Sync for Engine
impl Unpin for Engine
impl !UnwindSafe for Engine
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Erasable for T
impl<T> Erasable for T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);