Skip to main content

Owner

Struct Owner 

Source
pub struct Owner { /* private fields */ }
Expand description

Owns every signal, memo, effect and child owner created through it, and frees them all when it is disposed.

Each widget opens one, and dropping the widget disposes it. crabshell-ui’s Cx wraps an Owner. Get a root owner from Runtime::new_owner and nested ones from child.

Implementations§

Source§

impl Owner

Source

pub fn child(&self) -> Owner

Creates an owner inside this one. Disposing this owner disposes the child too.

§Panics

This and the other create methods panic if this owner was disposed.

Source

pub fn signal<T: 'static>(&self, value: T) -> Signal<T>

Creates a Signal holding value.

Source

pub fn memo<T: PartialEq + 'static>( &self, f: impl FnMut() -> T + 'static, ) -> Memo<T>

Creates a Memo that derives its value with f. f first runs when something reads the memo.

Source

pub fn effect(&self, f: impl FnMut() + 'static) -> Effect

Creates an Effect that runs f in the next flush round (see Effect), and again whenever something f read changes.

Source

pub fn effect_scoped(&self, f: impl FnMut(Owner) + 'static) -> Effect

Like effect, for an effect that builds things on every run, such as a list’s child widgets.

Each run gets a fresh owner, scope, to create them under. The scope belongs to the effect itself: before the next run, the previous scope is disposed with everything in it, and when the effect stops, its last scope goes with it. The effect stops when this owner is disposed, or when it is disabled after a panic or a dependency cycle.

Source

pub fn is_disposed(&self) -> bool

Whether this owner was disposed, itself or with its parent, so code that may outlive its context can check before it creates anything under it, which would panic.

Source

pub fn dispose(self)

Frees this owner and everything created under it, child owners included. Their values and closures are dropped and their effects stop. Afterwards their handles’ get() panics and try_get() returns None. Disposing an owner twice does nothing.

Source

pub fn named(self, name: impl Into<String>) -> Self

Gives the owner a debug name, such as a widget path. Log lines about its unnamed nodes mention it.

Trait Implementations§

Source§

impl Clone for Owner

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Owner

Source§

impl Debug for Owner

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Owner

Source§

impl Hash for Owner

Source§

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Owner

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

Auto Trait Implementations§

§

impl !Send for Owner

§

impl !Sync for Owner

§

impl Forget for Owner

§

impl Freeze for Owner

§

impl Move for Owner

§

impl RefUnwindSafe for Owner

§

impl Unpin for Owner

§

impl UnsafeUnpin for Owner

§

impl UnwindSafe for Owner

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more