pub struct ArcNode<U: UiNode>(/* private fields */);
Expand description
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§
source§impl<U: UiNode> ArcNode<U>
impl<U: UiNode> ArcNode<U>
sourcepub fn new_cyclic(node: impl FnOnce(WeakNode<U>) -> U) -> Self
pub fn new_cyclic(node: impl FnOnce(WeakNode<U>) -> U) -> Self
New node that contains a weak reference to itself.
Note that the weak reference cannot be upgraded during the call to node
.
sourcepub fn downgrade(&self) -> WeakNode<U>
pub fn downgrade(&self) -> WeakNode<U>
Creates a WeakNode<U>
reference to this node.
sourcepub fn set(&self, new_node: U)
pub fn set(&self, new_node: U)
Replace the current node with the new_node
in the current slot.
The previous node is deinited and the new_node
is inited.
sourcepub fn take_when(&self, var: impl IntoVar<bool>) -> TakeSlot<U, impl TakeOn>
pub fn take_when(&self, var: impl IntoVar<bool>) -> TakeSlot<U, impl TakeOn>
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
.
sourcepub fn take_on<A: EventArgs>(
&self,
event: Event<A>,
filter: impl FnMut(&A) -> bool + Send + 'static,
take_on_init: bool,
) -> TakeSlot<U, impl TakeOn>
pub fn take_on<A: EventArgs>( &self, event: Event<A>, filter: impl FnMut(&A) -> bool + Send + 'static, take_on_init: bool, ) -> TakeSlot<U, impl TakeOn>
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
.
sourcepub fn take_on_init(&self) -> TakeSlot<U, impl TakeOn>
pub fn take_on_init(&self) -> TakeSlot<U, impl TakeOn>
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)
.
sourcepub fn try_context<R>(
&self,
update_mode: WidgetUpdateMode,
f: impl FnOnce() -> R,
) -> Option<R>
pub fn try_context<R>( &self, update_mode: WidgetUpdateMode, f: impl FnOnce() -> R, ) -> Option<R>
Calls f
in the context of the node, if it can be locked and is a full widget.
Trait Implementations§
Auto Trait Implementations§
impl<U> Freeze for ArcNode<U>
impl<U> !RefUnwindSafe for ArcNode<U>
impl<U> Send for ArcNode<U>
impl<U> Sync for ArcNode<U>
impl<U> Unpin for ArcNode<U>
impl<U> !UnwindSafe for ArcNode<U>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more