Struct UiNode 

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

A stable declarative UI node. Script-produced nodes contain no GPUI values or lifetimes; trusted Rust Hosts may attach opaque foreground callbacks.

A node is a shared, copy-on-write handle: Rhai passes nodes by value (variables, arrays, arguments), so a clone must not copy the subtree.

Implementations

impl UiNode

pub fn text(text: impl Into<ImmutableString>) -> Self

pub fn rich_text(spans: Vec<Span>) -> Self

pub fn canvas(scene: CanvasScene) -> Self

pub fn svg(source: impl Into<String>) -> Result<Self, InlineSvgError>

Construct a validated self-contained inline SVG atom.

Errors

Returns crate::InlineSvgError for active, external, or oversized markup.

pub fn box_node(children: Vec<Self>) -> Self

pub fn fragment(children: Vec<Self>) -> Self

pub fn column(children: Vec<Self>) -> Self

pub fn row(children: Vec<Self>) -> Self

pub fn custom(primitive: PrimitiveNode) -> Self

pub fn error_boundary(child: Self, fallback: Self) -> Self

pub fn image(handle: OpaqueHandle) -> Self

pub fn asset_image(asset: AssetId) -> Self

pub fn directional_image( left_to_right: OpaqueHandle, right_to_left: OpaqueHandle, ) -> Self

pub fn directional_asset_image( left_to_right: AssetId, right_to_left: AssetId, ) -> Self

pub fn overlay(trigger: Self, content: Self, spec: OverlayNodeSpec) -> Self

pub fn layer(content: Self, spec: LayerNodeSpec) -> Self

pub fn virtual_collection(spec: VirtualCollectionNodeSpec) -> Self

pub fn with_key(self, key: impl Into<ImmutableString>) -> Self

pub fn with_style(self, style: &Style) -> Self

pub fn with_signal_binding( self, property: SignalProperty, signal: NativeSignal, ) -> Result<Self, SignalError>

Bind one approved hot property to a component-scoped native signal.

Errors

Returns a property/type mismatch without changing the node.

pub fn with_signal_style( self, signal: NativeSignal, states: BTreeMap<String, Style>, ) -> Result<Self, SignalError>

Merge states[value] into this node’s style, where value is the current value of a string signal.

Errors

Returns crate::SignalError::TypeMismatch for a signal that is not a string signal.

pub fn signal_style(&self) -> Option<&SignalStyle>

pub fn with_element_ref(self, reference: ElementRef) -> Self

pub fn with_scrollbars(self, spec: ScrollbarSpec) -> Self

pub fn with_part_styles(self, styles: BTreeMap<String, Style>) -> Self

pub fn with_part_style(self, part: impl Into<String>, style: Style) -> Self

pub fn with_source(self, source: SourceLocation) -> Self

pub fn component_root(&self) -> Option<&ComponentInstancePath>

pub fn with_environment(self, values: &Map) -> Result<Self, String>

Set environment values inherited by this node’s subtree, merging with values set earlier on the same node. Names and values are snake_case strings; whether they are declared is decided by the active token base.

Errors

Returns a message for non-string or malformed entries, or more than crate::token::MAX_ENVIRONMENT_VALUES names.

pub fn with_attribute(self, name: impl Into<String>, value: UiValue) -> Self

pub fn with_handler( self, event: impl Into<String>, handler: impl Into<UiEventHandler>, ) -> Self

pub fn with_handler_phase( self, event: impl Into<String>, phase: EventPhase, handler: impl Into<UiEventHandler>, ) -> Self

pub fn with_value_handler( self, event: impl Into<String>, handler: impl Into<UiEventHandler>, value: UiValue, ) -> Self

Append a handler that receives value as its payload; the node’s other handlers for event keep their own payloads.

pub fn with_host_handler( self, event: impl Into<String>, callback: HostCallback, ) -> Self

pub fn with_handler_payload( self, event: impl Into<String>, payload: UiValue, ) -> Self

pub fn with_motion(self, animation: MotionSource) -> Self

pub fn with_exit_motion(self, motion: MotionSource) -> Self

pub fn with_progress_motion(self, binding: MotionProgressBinding) -> Self

pub fn with_motion_replay_key(self, key: impl Into<String>) -> Self

pub fn with_motion_particle_count(self, count: usize) -> Self

pub fn with_timeline(self, timeline: MotionTimeline) -> Self

pub fn with_layout_motion(self, duration_ms: u64, easing: MotionEasing) -> Self

Opt this node into committed-geometry layout motion.

pub fn with_shared_layout( self, group: impl Into<String>, id: impl Into<String>, ) -> Self

Assign a same-window shared-layout identity to this real node.

pub fn with_shared_layout_id(self, id: impl Into<String>) -> Self

pub fn handlers(&self) -> &BTreeMap<String, Vec<UiEventBinding>>

pub fn handler(&self, event: &str) -> Option<&UiEventHandler>

pub fn event_handlers(&self, event: &str) -> &[UiEventBinding]

pub fn handler_payload(&self, event: &str) -> Option<&UiValue>

The payload set for event with Self::with_handler_payload, else the value of the last handler declared with one.

pub fn motions(&self) -> &[MotionSource]

pub fn exit_motions(&self) -> &[MotionSource]

pub fn progress_motions(&self) -> &[MotionProgressBinding]

pub fn timelines(&self) -> &[MotionTimeline]

pub fn kind(&self) -> &UiNodeKind

pub fn kind_tag(&self) -> UiNodeKindTag

pub fn key(&self) -> Option<&NodeKey>

pub fn style(&self) -> &Style

pub fn part_style(&self, part: &str) -> Option<&Style>

pub fn part_styles(&self) -> impl Iterator<Item = (&str, &Style)>

pub fn source(&self) -> Option<&SourceLocation>

pub fn attributes(&self) -> &BTreeMap<String, UiValue>

pub fn signal_bindings( &self, ) -> impl ExactSizeIterator<Item = (SignalProperty, &NativeSignal)>

pub fn element_ref(&self) -> Option<&ElementRef>

Trait Implementations

impl Clone for UiNode

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CustomType for UiNode

fn build(builder: TypeBuilder<'_, Self>)

Builds the custom type for use with the Engine.

impl Debug for UiNode

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for UiNode

type Target = UiNodeData

The resulting type after dereferencing.

fn deref(&self) -> &UiNodeData

Dereferences the value.

impl DerefMut for UiNode

fn deref_mut(&mut self) -> &mut UiNodeData

Mutably dereferences the value.

impl PartialEq for UiNode

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.