Struct ArcNode 

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

A reference counted UiNode.

Nodes can only be used in one place at a time, this struct allows the creation of slots that are UiNode implementers that can exclusive take the referenced node as its child.

When a slot takes the node it is deinited in the previous place and reinited in the slot place.

Slots hold a strong reference to the node when they have it as their child and a weak reference when they don’t.

Implementations

impl ArcNode

pub fn new(node: impl IntoUiNode) -> Self

New node.

pub fn new_cyclic(node: impl FnOnce(WeakNode) -> UiNode) -> Self

New node that contains a weak reference to itself.

Note that the weak reference cannot be upgraded during the call to node.

pub fn downgrade(&self) -> WeakNode

Creates a WeakNode reference to this node.

pub fn set(&self, new_node: impl IntoUiNode)

Replace the current node with the new_node in the current slot.

The previous node is deinited and the new_node is inited.

pub fn take_when(&self, var: impl IntoVar<bool>) -> UiNode

Create a slot node that takes ownership of this node when var updates to true.

The slot node also takes ownership on init if the var is already true.

pub fn take_on<A, F>( &self, event: Event<A>, filter: F, take_on_init: bool, ) -> UiNode

where A: EventArgs, F: FnMut(&A) -> bool + Send + 'static,

Create a slot node that takes ownership of this node when event updates and filter returns true.

The slot node also takes ownership on init if take_on_init is true.

pub fn take_on_init(&self) -> UiNode

Create a slot node that takes ownership of this node as soon as the node is inited.

This is equivalent to self.take_when(true).

pub fn try_node<R>(&self, visitor: impl FnOnce(&mut UiNode) -> R) -> Option<R>

Call visitor on a exclusive lock of the node.

Note that the node is not visited in their current slot context, only use this to inspect state.

Returns None if the node is locked, this will happen if calling from inside the node or an ancestor.

pub fn try_context<R>( &self, update_mode: WidgetUpdateMode, visitor: impl FnOnce() -> R, ) -> Option<R>

Calls visitor in the widget context of the node, if it is an widget.

Note that only the widget context is loaded in visitor, not the full slot context.

Returns None if the node is locked or is not an widget. The node will be locked if calling from inside the node or an ancestor.

Trait Implementations

impl Clone for ArcNode

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.