Struct ScreenReg 

#[non_exhaustive]
pub struct ScreenReg {
    pub base_path: String,
    pub nav_label: Option<Text>,
    pub menu: Placement,
    pub permission: String,
    pub screen: Arc<dyn Screen>,
}

A registered screen: where it mounts, what it is called, and who may reach it.

Built with ScreenReg::new plus its builder methods. Non-exhaustive so the framework can learn something new about a screen after 1.0 without a major bump: anything it needs to know belongs here rather than as another trait method, which is also what keeps the code half replaceable at the plugin boundary.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

base_path: String

Path relative to the module’s admin base, starting with a slash.

nav_label: Option<Text>

Menu label, localized at render. None mounts it without a nav entry.

menu: Placement

Where the entry sits: under a section, with an icon, at a position.

permission: String

The permission every route under this screen requires. Required, because an unguarded screen exposes whatever it serves to any signed-in operator.

screen: Arc<dyn Screen>

Implementations

impl ScreenReg

pub fn new( base_path: impl Into<String>, permission: impl Into<String>, screen: Arc<dyn Screen>, ) -> Self

pub fn in_menu(self, label: impl Into<Text>) -> Self

Shows this screen in the menu under label.

pub fn menu(self, placement: Placement) -> Self

Where the menu entry sits. See Placement.