Struct Module 

pub struct Module<T> {
    pub inner: Rc<Inner<T>>,
}

A cheaply-clonable, reference-counted handle to a registered module.

Fields

inner: Rc<Inner<T>>

Shared inner state holding the module and its metadata.

Implementations

impl<T> Module<T>

where T: App + 'static,

pub fn any(&self) -> Rc<RefCell<dyn ModuleT<Context = T>>>

Returns a cloned reference-counted handle to the inner type-erased module.

pub fn main(&self, core: &mut T)

Runs the module’s main update step, invoking its ModuleT::main hook.

pub fn activate(&self, core: &mut T)

Activates the module, invoking its ModuleT::activate hook.

pub fn deactivate(&self, core: &mut T)

Deactivates the module, invoking its ModuleT::deactivate hook.

pub fn render( &self, core: &mut T, ctx: &Context, frame: &mut Frame, ui: &mut Ui, )

Applies the module’s style (mobile or default text styles) and then renders the module’s UI.

pub fn name(&self) -> &str

Returns the module’s display name, falling back to the derived type name when the module does not provide its own.

pub fn modal(&self) -> bool

Returns whether the module should be presented modally.

pub fn secure(&self) -> bool

Returns whether the module is marked as secure.

pub fn type_id(&self) -> TypeId

Returns the TypeId of the concrete module type.

pub fn as_ref<M>(&self) -> Ref<'_, M>

where M: ModuleT + 'static,

Borrows the inner module downcast to the concrete type M, panicking if the stored module is not of that type.

pub fn as_mut<M>(&mut self) -> RefMut<'_, M>

where M: ModuleT + 'static,

Mutably borrows the inner module downcast to the concrete type M, panicking if the stored module is not of that type.

Trait Implementations

impl<T> Clone for Module<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Module<T>

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

Formats the value using the given formatter.

impl<T> Eq for Module<T>

impl<T, M> From<M> for Module<T>

where M: ModuleT<Context = T> + 'static, T: App,

fn from(section: M) -> Self

Converts to this type from the input type.

impl<T> PartialEq for Module<T>

fn eq(&self, other: &Self) -> 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.