Struct Owner 

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

Identifier for an Owner slot in the runtime’s owner map. Generational — disposing an owner invalidates outstanding Owners pointing at the same slot index.

Implementations

impl Owner

pub fn new(parent: Option<Owner>) -> Owner

Create a new owner. If parent is None the current top-of-stack owner is used (or the owner becomes a root if the stack is empty).

The new owner inherits its parent’s paused flag — so a sub-component mounted while its containing route is suspended starts paused, and its effects won’t fire until the route resumes.

pub fn detached_root() -> Owner

Create a parentless root owner, ignoring whatever owner is currently on the stack.

Unlike Owner::new(None) — which adopts the current top-of-stack owner as parent — this always produces a detached root. Use it for process-global singletons whose lifetime must not be tied to the (possibly short-lived) owner that happens to be active when the singleton is first touched.

The canonical case is a module that lazily mints an arena-backed handle on first access (e.g. whisker-safe-area): if that first access lands inside a per-route / per-component owner, minting under new(None) would free the handle when that scope disposes, and a later read would hit a disposed node. Minting under a detached_root() (then never disposing it) keeps the handle alive for the whole process — the intended semantics for a singleton.

The returned owner is never auto-disposed; the caller is expected to leak it (i.e. drop the handle without calling dispose) for genuine process-lifetime data.

pub fn with<R>(self, f: impl FnOnce() -> R) -> R

Push self as the current scope, run f, pop back. Reactive primitives (signal(), effect(), computed(), view elements created via render!) allocated inside f will belong to this owner.

pub fn dispose(self)

Dispose self, freeing all its descendants, nodes, and running its cleanup callbacks.

Recursive — disposes children first, then this owner. Safe to call even if the owner has already been disposed (no-op).

pub fn pause(self)

Pause self (and its descendants): effects and computeds whose scope is the paused subtree skip flush. Their scheduled re-runs land on the runtime’s deferred list until Owner::resume drains them back.

Idempotent — pausing an already-paused owner is a no-op. The cascade walks the children tree breadth-first; new descendants created while paused inherit the flag via Owner::new.

Used by StackLayout to freeze back-stack entries that are mounted-but-off-screen, matching iOS UINavigationController / Android Fragment back-stack semantics: state survives but no CPU is spent on signal-driven re-renders behind the top route.

pub fn resume(self)

Resume self (and its descendants): clear the paused flag and move any of its deferred effects back onto the pending queue so they fire on the next flush.

Idempotent. Iterates super::runtime::ReactiveRuntime::deferred and re-queues every node whose owner is no longer paused — including descendants resumed by this cascade, and any deferred node whose owner happens to have been unpaused by an earlier call.

pub fn is_paused(self) -> bool

Whether self is currently paused. Mainly for tests; production code should drive pause / resume from the lifecycle layer and not branch on the flag directly.

Trait Implementations

impl Clone for Owner

fn clone(&self) -> Owner

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Owner

impl Debug for Owner

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

Formats the value using the given formatter.

impl Default for Owner

fn default() -> Owner

Returns the “default value” for a type.

impl Eq for Owner

impl From<KeyData> for Owner

fn from(k: KeyData) -> Self

Converts to this type from the input type.

impl Hash for Owner

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Key for Owner

fn data(&self) -> KeyData

Gets the KeyData stored in this key.

fn null() -> Self

Creates a new key that is always invalid and distinct from any non-null key. A null key can only be created through this method (or default initialization of keys made with new_key_type!, which calls this method).

fn is_null(&self) -> bool

Checks if a key is null. There is only a single null key, that is a.is_null() && b.is_null() implies a == b.

impl Ord for Owner

fn cmp(&self, other: &Owner) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Owner

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Owner

fn partial_cmp(&self, other: &Owner) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Owner