Skip to main content

CommandRegistry

Struct CommandRegistry 

Source
pub struct CommandRegistry { /* private fields */ }
Expand description

Thread-safe registry of known Tauri commands, indexed by name.

Implementations§

Source§

impl CommandRegistry

Source

pub fn new() -> Self

Creates an empty command registry.

use victauri_core::CommandRegistry;

let registry = CommandRegistry::new();
assert_eq!(registry.count(), 0);
assert!(registry.list().is_empty());
Source

pub fn register(&self, info: CommandInfo)

Registers a command, replacing any existing entry with the same name.

use victauri_core::{CommandRegistry, CommandInfo};

let registry = CommandRegistry::new();
registry.register(CommandInfo::new("greet").with_description("Say hello"));
assert_eq!(registry.count(), 1);
assert!(registry.get("greet").is_some());
Source

pub fn get(&self, name: &str) -> Option<CommandInfo>

Looks up a command by exact name.

Source

pub fn list(&self) -> Vec<CommandInfo>

Returns all registered commands in alphabetical order.

Source

pub fn count(&self) -> usize

Returns the number of registered commands.

Source

pub fn search(&self, query: &str) -> Vec<CommandInfo>

Searches commands by substring match on name or description (case-insensitive).

§Examples
use victauri_core::{CommandRegistry, CommandInfo};

let registry = CommandRegistry::new();
registry.register(
    CommandInfo::new("get_settings").with_description("Retrieve app settings"),
);
let results = registry.search("settings");
assert_eq!(results.len(), 1);
assert_eq!(results[0].name, "get_settings");
Source

pub fn resolve(&self, query: &str) -> Vec<ScoredCommand>

Resolves a natural-language query to commands ranked by relevance score.

§Examples
use victauri_core::{CommandRegistry, CommandInfo};

let registry = CommandRegistry::new();
registry.register(
    CommandInfo::new("get_settings")
        .with_description("Retrieve app settings")
        .with_intent("fetch configuration")
        .with_category("settings"),
);
let results = registry.resolve("get settings");
assert!(!results.is_empty());
assert!(results[0].score > 0.0);
Source§

impl CommandRegistry

Source

pub fn from_auto_discovery() -> Self

Creates a registry pre-populated with all #[inspectable] commands.

Uses inventory to collect every CommandInfo that was submitted at link time by the #[inspectable] macro. This replaces manual register_commands! or .commands(&[...]) calls.

use victauri_core::CommandRegistry;

let registry = CommandRegistry::from_auto_discovery();
// Contains all #[inspectable] commands from the binary

Trait Implementations§

Source§

impl Clone for CommandRegistry

Source§

fn clone(&self) -> CommandRegistry

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CommandRegistry

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CommandRegistry

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.