Struct Registry 

pub struct Registry { /* private fields */ }

Every command of an app, shared by its menus, search, keys and agent (a cheap handle: clones share the same list).

Implementations

impl Registry

pub fn new(commands: Vec<CommandSpec>) -> Self

A registry holding commands.

pub fn add(&self, command: CommandSpec)

Adds a command, replacing one with the same id.

pub fn extend(&self, commands: impl IntoIterator<Item = CommandSpec>)

Adds several commands (Registry::add each).

pub fn remove(&self, id: &str) -> bool

Removes the command id; whether it was there.

pub fn get(&self, id: &str) -> Option<CommandSpec>

The command id.

pub fn all(&self) -> Vec<CommandSpec>

Every command, in the order added.

pub fn len(&self) -> usize

How many commands it holds.

pub fn is_empty(&self) -> bool

Whether it holds none.

pub fn provide( &self, id: impl Into<SharedString>, provider: impl Fn(&App) -> Vec<MenuItem> + 'static, )

Registers the menu provider id (replacing one with the same id): a MenuItem::Provided naming it shows the entries it makes when the menu opens.

pub fn provided(&self, id: &str, cx: &App) -> Vec<MenuItem>

The entries the provider id makes now (none when there is no such provider).

pub fn check(&self, id: &str, cx: &App) -> Result<(), String>

Whether id can run now (Err says why not, or that there is no such command).

pub fn run( &self, id: &str, args: Value, window: &mut Window, cx: &mut App, ) -> Result<Value, String>

Runs id with args (null for none), when it can run now, as the person did.

pub fn run_as( &self, actor: Actor, via: &str, id: &str, args: Value, window: &mut Window, cx: &mut App, ) -> Result<Value, String>

Runs id with args for actor, started from via (menu, key, search, title bar, agent), and records it in the activity log (crate::activity), refused or not.

pub fn bind_keys(&self, context: Option<&str>, cx: &mut App) -> Vec<String>

Binds every command’s key to RunCommand (globally; context limits them to a part of the window, as GPUI’s key contexts do). A key that does not parse is skipped and named in the result.

pub fn menu_button( &self, id: impl Into<SharedString>, menu: &MenuSpec, ) -> AnyElement

A ghost button titled as menu, opening its entries: each command with its icon, key and check mark; a command that cannot run now is greyed with its reason under it.

pub fn fill_menu( &self, menu: PopupMenu, items: &[MenuItem], window: &mut Window, cx: &mut Context<'_, PopupMenu>, ) -> PopupMenu

Adds items to menu (as Registry::menu_button does).

Trait Implementations

impl Clone for Registry

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Registry

fn default() -> Self

Returns the “default value” for a type.