Struct dioxus_core::scope::Scope

pub struct Scope {
    pub hooks: RefCell<Vec<*mut Hook>>,
    pub hook_arena: Arena<Hook>,
    pub parent: Option<Index>,
    pub frames: ActiveFrame,
    pub listeners: Vec<*const dyn Fn(VirtualEvent)>,
    pub props: Box<dyn Any>,
    pub caller: *const (),
}

Every component in Dioxus is represented by a Scope.

Scopes contain the state for hooks, the component’s props, and other lifecycle information.

Scopes are allocated in a generational arena. As components are mounted/unmounted, they will replace slots of dead components. The actual contents of the hooks, though, will be allocated with the standard allocator. These should not allocate as frequently.

Fields

hooks: RefCell<Vec<*mut Hook>>

hook_arena: Arena<Hook>

parent: Option<Index>

frames: ActiveFrame

listeners: Vec<*const dyn Fn(VirtualEvent)>

props: Box<dyn Any>

caller: *const ()

Implementations

impl Scope

pub fn new<'a, P1, P2: 'static>(
    f: FC<P1>,
    props: P1,
    parent: Option<Index>
) -> Self

pub fn run<'bump, PLocked: Sized + 'static>(&'bump mut self)

Create a new context and run the component with references from the Virtual Dom This function downcasts the function pointer based on the stored props_type

Props is ?Sized because we borrow the props and don’t need to know the size. P (sized) is used as a marker (unsized)

pub fn new_frame<'bump>(&'bump self) -> &'bump VNode<'bump>

Accessor to get the root node and its children (safely)
Scope is self-referntial, so we are forced to use the ’static lifetime to cheat

pub fn old_frame<'bump>(&'bump self) -> &'bump VNode<'bump>