Struct CommandInfo 

#[non_exhaustive]
pub struct CommandInfo {
    pub name: String,
    pub plugin: Option<String>,
    pub description: Option<String>,
    pub args: Vec<CommandArg>,
    pub return_type: Option<String>,
    pub is_async: bool,
    pub intent: Option<String>,
    pub category: Option<String>,
    pub examples: Vec<String>,
}

Metadata for a registered Tauri command, including intent and schema information.

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.

name: String

Fully qualified command name (e.g. “get_settings”).

plugin: Option<String>

Plugin namespace, if the command belongs to a Tauri plugin.

description: Option<String>

Human-readable description of what the command does.

args: Vec<CommandArg>

Ordered list of arguments the command accepts.

return_type: Option<String>

Rust return type as a string (e.g. “Result<Settings, Error>”).

is_async: bool

Whether the command handler is async.

intent: Option<String>

Natural-language intent phrase for NL-to-command resolution.

category: Option<String>

Grouping category (e.g. “settings”, “counter”).

examples: Vec<String>

Example natural-language queries that should resolve to this command.

Implementations

impl CommandInfo

pub fn new(name: impl Into<String>) -> CommandInfo

Creates a new command with the given name and all optional fields set to None/empty.

Examples

use victauri_core::CommandInfo;

let cmd = CommandInfo::new("greet");
assert_eq!(cmd.name, "greet");
assert!(cmd.description.is_none());

pub fn with_description(self, description: impl Into<String>) -> CommandInfo

Sets the description.

pub fn with_intent(self, intent: impl Into<String>) -> CommandInfo

Sets the intent phrase for natural-language resolution.

pub fn with_category(self, category: impl Into<String>) -> CommandInfo

Sets the category.

pub fn with_plugin(self, plugin: impl Into<String>) -> CommandInfo

Sets the plugin namespace.

pub fn with_args(self, args: Vec<CommandArg>) -> CommandInfo

Replaces the argument list.

pub fn with_arg(self, arg: CommandArg) -> CommandInfo

Appends one argument.

pub fn with_return_type(self, return_type: impl Into<String>) -> CommandInfo

Sets the Rust return type string.

pub fn with_async(self, is_async: bool) -> CommandInfo

Sets whether the command handler is async.

pub fn with_examples(self, examples: Vec<String>) -> CommandInfo

Replaces the example natural-language queries.

pub fn with_example(self, example: impl Into<String>) -> CommandInfo

Appends one example natural-language query.

Trait Implementations

impl Clone for CommandInfo

fn clone(&self) -> CommandInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandInfo

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CommandInfo

fn deserialize<__D>( __deserializer: __D, ) -> Result<CommandInfo, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for CommandInfo

impl PartialEq for CommandInfo

fn eq(&self, other: &CommandInfo) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for CommandInfo

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CommandInfo