Struct Handle 

pub struct Handle { /* private fields */ }

A universal node handle. 16 bytes, Copy, Send, !Sync.

Internally: RawId (8 bytes) + DocumentCell (8 bytes). All node types are newtypes around this.

See module-level doc for the thread-safety invariants.

Implementations

impl Handle

pub fn raw(&self) -> RawId

The raw node ID (index + generation). Can be sent across threads.

pub fn is_alive(&self) -> bool

Check if this node is still alive.

pub fn read_data<D: 'static, R: 'static>( &self, f: impl FnOnce(&D) -> R, ) -> Option<R>

Read element-specific data through a scoped closure.

pub fn write_data<D: 'static, R: 'static>( &self, f: impl FnOnce(&mut D) -> R, ) -> Option<R>

Write element-specific data. Marks dirty.

pub fn tag_name(&self) -> Option<&'static str>

Tag name (e.g., “div”, “button”). None for non-element nodes.

pub fn id(&self) -> String

Get the id attribute.

pub fn set_id(&self, id: impl Into<String>)

Set the id attribute.

pub fn class_name(&self) -> String

Get the class attribute.

pub fn set_class_name(&self, class: impl Into<String>)

Set the class attribute.

pub fn attribute(&self, name: &str) -> Option<String>

Returns the attribute value for name, or None if absent.

pub fn set_attribute(&self, name: &str, value: impl Into<String>)

Set an attribute.

pub fn remove_attribute(&self, name: &str) -> Option<String>

Remove an attribute.

pub fn class_add(&self, name: &str)

Add a CSS class. No-op if already present. Chrome equivalent: element.classList.add("name").

pub fn class_remove(&self, name: &str)

Remove a CSS class. No-op if not present. Chrome equivalent: element.classList.remove("name").

pub fn class_toggle(&self, name: &str) -> bool

Toggle a CSS class. Returns true if now present. Chrome equivalent: element.classList.toggle("name").

pub fn class_contains(&self, name: &str) -> bool

Check if an element has a CSS class. Chrome equivalent: element.classList.contains("name").

pub fn append(&self, child: impl Into<Handle>) -> &Self

Append child as the last child.

Accepts any node type (HtmlDivElement, Text, Handle, etc.).

pub fn child(self, child: impl Into<Handle>) -> Self

Append a child and return self (Copy) for chaining.

doc.root()
    .child(doc.div())
    .child(doc.div());

pub fn add_children<I, C>(self, items: I) -> Self

where I: IntoIterator<Item = C>, C: Into<Handle>,

Append multiple children at once.

pub fn insert_before(&self, child: impl Into<Handle>)

Insert child before this node.

pub fn detach(&self)

Remove from parent.

pub fn destroy(&self)

Destroy this node. All handles become stale.

pub fn parent(&self) -> Option<Handle>

Parent node.

pub fn first_child(&self) -> Option<Handle>

First child.

pub fn last_child(&self) -> Option<Handle>

Last child.

pub fn next_sibling(&self) -> Option<Handle>

Next sibling.

pub fn prev_sibling(&self) -> Option<Handle>

Previous sibling.

pub fn children(&self) -> Vec<Handle>

All children.

pub fn node_kind(&self) -> Option<NodeType>

pub fn is_element(&self) -> bool

pub fn is_text(&self) -> bool

pub fn is_document(&self) -> bool

pub fn style(&self) -> StyleAccess

Per-property style access — like JavaScript’s element.style.

div.style().color(AbsoluteColor::RED);
div.style().display(Display::Flex);

pub fn dispatch_event(&self, event: &dyn Event) -> bool

Dispatch an event to this node.

Runs the full capture -> target -> bubble pipeline. Returns true if the default action was NOT prevented.

This mirrors EventTarget::dispatch_event() but works on raw Handle without requiring the HasHandle trait (which would conflict with the blanket From<T: HasHandle> impl). Used by EventHandler after hit testing returns a node index resolved to a Handle.

Trait Implementations

impl Clone for Handle

fn clone(&self) -> Handle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Handle

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

Formats the value using the given formatter.

impl<T: HasHandle> From<T> for Handle

Any type with HasHandle can convert to Handle. Enables doc.root().append(btn) instead of doc.root().append(btn.handle()).

fn from(value: T) -> Self

Converts to this type from the input type.

impl Copy for Handle

impl Send for Handle