Struct WebUIHydrationPlugin 

pub struct WebUIHydrationPlugin;

WebUI handler plugin that emits hydration markers.

Emits lightweight HTML comment markers around structural boundaries (for-loops and if-conditions) so the client can hydrate in-place without reparenting DOM nodes.

Implementations

impl WebUIHydrationPlugin

pub fn new() -> Self

Create a new WebUI handler plugin.

Trait Implementations

impl Default for WebUIHydrationPlugin

fn default() -> Self

Returns the “default value” for a type.

impl HandlerPlugin for WebUIHydrationPlugin

fn emit_templates( &self, protocol: &WebUIProtocol, components: &HashSet<String>, nonce: Option<&str>, writer: &mut dyn ResponseWriter, ) -> Result<()>

Emit all WebUI component templates inside a single <script> tag for SSR. Templates are raw JS IIFE strings (no <script> wrapper) stored in the protocol — the <script> tag is only added here for the SSR HTML output. Partial SPA responses send the raw JS directly and the router evaluates it client-side.

NOTE: When collect_template_js returns Some(...), lib.rs merges the templates into the consolidated window.__webui script block and this method is not called. It remains as a fallback for non-consolidated code paths.

fn collect_template_js( &self, protocol: &WebUIProtocol, components: &HashSet<String>, ) -> Option<Vec<String>>

Collect raw JS template IIFE strings for embedding in the consolidated window.__webui script block. Returns Some(vec) with non-empty template sources, or None if there are no templates to emit.

fn push_scope(&mut self)

Enter a new scope (component or for-loop item boundary). Typically resets per-scope counters.

fn pop_scope(&mut self)

Exit the current scope, restoring the parent scope state.

fn on_binding_start( &mut self, _name: &str, _writer: &mut dyn ResponseWriter, ) -> Result<()>

Called before rendering a signal binding.

fn on_binding_end( &mut self, _name: &str, _writer: &mut dyn ResponseWriter, ) -> Result<()>

Called after rendering a signal binding.

fn on_for_start( &mut self, _name: &str, writer: &mut dyn ResponseWriter, ) -> Result<()>

Called before rendering a for-loop block. Defaults to on_binding_start.

fn on_for_end( &mut self, _name: &str, writer: &mut dyn ResponseWriter, ) -> Result<()>

Called after rendering a for-loop block. Defaults to on_binding_end.

fn on_if_start( &mut self, _name: &str, writer: &mut dyn ResponseWriter, ) -> Result<()>

Called before rendering an if-condition block. Defaults to on_binding_start.

fn on_if_end( &mut self, _name: &str, writer: &mut dyn ResponseWriter, ) -> Result<()>

Called after rendering an if-condition block. Defaults to on_binding_end.

fn on_repeat_item_start( &mut self, _index: usize, writer: &mut dyn ResponseWriter, ) -> Result<()>

Called before rendering a repeat item in a for loop.

fn on_repeat_item_end( &mut self, _index: usize, _writer: &mut dyn ResponseWriter, ) -> Result<()>

Called after rendering a repeat item.

fn on_element_data( &mut self, _data: &[u8], _writer: &mut dyn ResponseWriter, ) -> Result<()>

Called when parser-produced element metadata is encountered.

fn write_route_component_state( &self, _state: &Value, _writer: &mut dyn ResponseWriter, ) -> Result<()>

Called when emitting a matched route component’s opening tag. Plugins can write framework-specific attributes before the closing >. The default is a no-op.