Skip to main content

BuildCtx

Struct BuildCtx 

Source
pub struct BuildCtx<S: AppState> {
    pub registry: ActionRegistry<S>,
    pub animation_requests: Vec<(WidgetNodeId, AnimationRequest)>,
    pub video_nodes: Vec<VideoRegistration>,
    pub web_nodes: Vec<WebRegistration>,
    pub portals: Vec<PortalEntry>,
    /* private fields */
}
Expand description

The mutable context passed to Widget::build.

BuildCtx is where widgets register side-effects that must survive beyond the build phase:

§Example

fn build(&self, ctx: &mut BuildCtx<S>, view: &View<S>) -> Node {
    let on_press = ctx.bind(MyAction { .. }, handler as fn(&mut S, MyAction));
    Button { on_press: Some(on_press), ..Default::default() }.into_node()
}

Fields§

§registry: ActionRegistry<S>

The action registry that accumulates handlers during the build phase.

§animation_requests: Vec<(WidgetNodeId, AnimationRequest)>

Pending animation requests.

§video_nodes: Vec<VideoRegistration>

Registered video nodes.

§web_nodes: Vec<WebRegistration>

Registered web view nodes.

§portals: Vec<PortalEntry>

Portal entries (overlays, modals, toasts).

Implementations§

Source§

impl<S: AppState> BuildCtx<S>

Source

pub fn new() -> Self

Source

pub fn bind<A: Action, H>(&mut self, action: A, handler: H) -> ActionEnvelope
where H: IntoHandler<S, A> + Send + Sync + 'static,

Source

pub fn request_animation_for( &mut self, target: WidgetNodeId, request: AnimationRequest, )

Source

pub fn register_video(&mut self, registration: VideoRegistration)

Source

pub fn register_web_view(&mut self, registration: WebRegistration)

Source

pub fn take_animation_requests( &mut self, ) -> Vec<(WidgetNodeId, AnimationRequest)>

Source

pub fn take_video_registrations(&mut self) -> Vec<VideoRegistration>

Source

pub fn take_web_registrations(&mut self) -> Vec<WebRegistration>

Source

pub fn register_portal(&mut self, node: Node)

Source

pub fn register_portal_with_id(&mut self, id: WidgetNodeId, node: Node)

Source

pub fn register_portal_with_layer( &mut self, layer: PortalLayer, id: Option<WidgetNodeId>, node: Node, )

Source

pub fn take_portals(&mut self) -> Vec<(Option<WidgetNodeId>, Node)>

Source

pub fn anim_for(&mut self, target: WidgetNodeId) -> AnimCtx<'_, S>

Source

pub fn video_controls(&self, target: WidgetNodeId) -> VideoControlCtx

Auto Trait Implementations§

§

impl<S> Freeze for BuildCtx<S>

§

impl<S> !RefUnwindSafe for BuildCtx<S>

§

impl<S> Send for BuildCtx<S>

§

impl<S> Sync for BuildCtx<S>

§

impl<S> Unpin for BuildCtx<S>

§

impl<S> UnsafeUnpin for BuildCtx<S>

§

impl<S> !UnwindSafe for BuildCtx<S>

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> 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> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.