Struct ComposeRenderer 

pub struct ComposeRenderer { /* private fields */ }

dioxus-core mutation sink that writes the Compose wire protocol directly.

Implementations

impl ComposeRenderer

pub fn new() -> Self

pub fn arena(&self) -> (*const u8, usize)

The batch arena, so a runtime that reads Host memory through a mapped view can be handed one.

pub fn begin_frame(&mut self)

pub fn finish_frame(&mut self) -> Result<&[u8], ProtocolError>

pub fn handler(&self, handler_id: u64) -> Option<(ElementId, u32, &'static str)>

pub fn set_text( &mut self, element: ElementId, text: &str, selection: Option<Selection>, )

pub fn set_theme(&mut self, theme: Theme)

The root theme record. Written once per rebuild, never per frame.

pub fn set_window(&mut self, window: Window)

The root window record. Written once per rebuild, never per frame.

pub fn set_text_node( &mut self, node_id: u32, text: &str, selection: Option<Selection>, )

pub fn register_asset(&mut self, asset_id: u32, kind: AssetKind, bytes: &[u8])

Copies one asset into the batch. The bytes ride behind the records, and the Renderer takes its own copy inside the call that carries them.

pub fn release_asset(&mut self, asset_id: u32)

pub fn show_message( &mut self, handler_id: u64, text: &str, action: &str, duration: MessageDuration, )

Writes one transient message into the batch.

It names no node, because a message is not in the tree: it is a sentence with a lifetime, and that lifetime belongs to the Renderer.

pub fn append_text_node(&mut self, node_id: u32, text: &str)

Append the streamed tail to a Text node without resending its whole value.

Trait Implementations

impl Default for ComposeRenderer

fn default() -> Self

Returns the “default value” for a type.

impl WriteMutations for ComposeRenderer

fn append_children(&mut self, id: ElementId, m: usize)

Add these m children to the target element

fn assign_node_id(&mut self, path: &'static [u8], id: ElementId)

Assign the element at the given path the target ElementId.

fn create_placeholder(&mut self, id: ElementId)

Create a placeholder in the DOM that we will use later.

fn create_text_node(&mut self, value: &str, id: ElementId)

Create a node specifically for text with the given value

fn load_template(&mut self, template: Template, index: usize, id: ElementId)

Load and clone an existing node from a template saved under that specific name

fn replace_node_with(&mut self, id: ElementId, m: usize)

Replace the target element (given by its ID) with the topmost m nodes on the stack

fn replace_placeholder_with_nodes(&mut self, path: &'static [u8], m: usize)

Replace an existing element in the template at the given path with the m nodes on the stack

fn insert_nodes_after(&mut self, id: ElementId, m: usize)

Insert a number of nodes after a given node.

fn insert_nodes_before(&mut self, id: ElementId, m: usize)

Insert a number of nodes before a given node.

fn set_attribute( &mut self, name: &'static str, _namespace: Option<&'static str>, value: &AttributeValue, id: ElementId, )

Set the value of a node’s attribute.

fn set_node_text(&mut self, value: &str, id: ElementId)

Set the text content of a node.

fn create_event_listener(&mut self, name: &'static str, id: ElementId)

Create a new Event Listener.

fn remove_event_listener(&mut self, name: &'static str, id: ElementId)

Remove an existing Event Listener.

fn remove_node(&mut self, id: ElementId)

Remove a particular node from the DOM

fn push_root(&mut self, id: ElementId)

Push the given root node onto our stack.