Skip to main content

BuildCtx

Struct BuildCtx 

Source
pub struct BuildCtx<'a> { /* private fields */ }
Expand description

Context threaded through View::build / View::rebuild: allocates unique WidgetIds from the render root’s counter and carries the effective focus chain (BuildCtx::has_focus) and element-replaced signal (BuildCtx::mark_element_replaced).

Implementations§

Source§

impl<'a> BuildCtx<'a>

Source

pub fn new(next_id: &'a mut u64) -> BuildCtx<'a>

Create a context borrowing the render root’s id counter.

The focus chain seeds true (“unknown, assume live”): over-releasing costs one tap, while under-releasing strands the shell’s IME surface over a dead widget. Seams that know the real value set it with BuildCtx::set_has_focus.

Source

pub fn with_shortcut_hints(self, hints: Rc<[ShortcutHint]>) -> BuildCtx<'a>

Hand the context its root’s last paint snapshot (BuildCtx::shortcut_hints).

Source

pub fn alloc_id(&mut self) -> WidgetId

Allocate a fresh, unique widget id.

Source

pub fn has_focus(&self) -> bool

Whether the recorded focus path is live from the root to the node being built/rebuilt/torn down: the rebuild-pass mirror of PaintCtx::has_focus.

A blur clears the link at the nearest common ancestor only, so a focused ChildPod flag below it goes stale harmlessly. A reconciler raises mark_focus_orphaned only when ctx.has_focus() && pod.is_focused(): the session is actually live.

Source

pub fn shortcut_hints(&self) -> Rc<[ShortcutHint]>

The previous paint’s shortcut declarations in paint order, unreachable ones included; label each chord with Chord::display. They lag this build by a frame, and are empty on a context its root did not seed.

Source

pub fn set_has_focus(&mut self, has_focus: bool)

Seed the focus chain for a seam that starts one (RenderRoot’s view diff, or a component carrying its outer chain across an inner BuildCtx). A container descending into a pod uses BuildCtx::with_focus_link, which can only narrow.

Run f with the focus chain extended by one link (link_focused is the pod’s is_focused flag), restoring it afterwards: the closure sees self.has_focus() && link_focused, so no descent can widen the chain.

Source

pub fn mark_element_replaced(&mut self)

Report that this view’s rebuild replaced its element’s widget while keeping the element type (an enum view switching arms, e.g. Either).

A reconciler detects an AnyView type swap by type id and drops the child pod’s capture and focus links; an enum keeps one static type, so it raises this signal instead. The nearest enclosing track_element_replaced scope consumes it (a pod inside the swapped subtree consumes its own); with no scope it is inert or reaches the next one up: an over-release, never an under-release.

Source

pub fn track_element_replaced<R>( &mut self, f: impl FnOnce(&mut BuildCtx<'a>) -> R, ) -> (R, bool)

Run f as a tracking scope for mark_element_replaced, returning f’s result and whether anything inside raised the signal. The caller’s pending value is saved and restored.

Auto Trait Implementations§

§

impl<'a> !Send for BuildCtx<'a>

§

impl<'a> !Sync for BuildCtx<'a>

§

impl<'a> !UnwindSafe for BuildCtx<'a>

§

impl<'a> Freeze for BuildCtx<'a>

§

impl<'a> RefUnwindSafe for BuildCtx<'a>

§

impl<'a> Unpin for BuildCtx<'a>

§

impl<'a> UnsafeUnpin for BuildCtx<'a>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> ErasedDestructor for T
where T: 'static,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

impl<T> StorageAccess<T> for T

Source§

fn as_borrowed(&self) -> &T

Borrows the value.
Source§

fn into_taken(self) -> T

Takes the value.
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