Struct CommandArg 

#[non_exhaustive]
pub struct CommandArg {
    pub name: String,
    pub key: Option<String>,
    pub type_name: String,
    pub required: bool,
    pub schema: Option<Value>,
}

Schema for a single argument of a registered command.

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

Argument name as declared in the Rust function signature.

key: Option<String>

The key the frontend must use for this argument in invoke(cmd, { key }), when it differs from name. Tauri renames arguments to camelCase by default (size_kb → sizeKb), so passing name would fail with “missing required key”. None means the key equals name.

type_name: String

Rust type name (e.g. “String”, “Option<u32>”).

required: bool

Whether the argument must be provided (not Option).

schema: Option<Value>

Optional JSON Schema for the argument’s expected shape.

Implementations

impl CommandArg

pub fn new( name: impl Into<String>, type_name: impl Into<String>, required: bool, ) -> Self

Creates an argument schema with no JSON Schema attached.

Examples

use victauri_core::{CommandArg, CommandInfo};

let cmd = CommandInfo::new("greet")
    .with_arg(CommandArg::new("name", "String", true))
    .with_return_type("String");
assert_eq!(cmd.args[0].name, "name");
assert!(cmd.args[0].required);

pub fn with_key(self, key: impl Into<String>) -> Self

Sets the IPC key the frontend passes this argument under, when it differs from the Rust name (see key).

use victauri_core::CommandArg;

let arg = CommandArg::new("size_kb", "usize", true).with_key("sizeKb");
assert_eq!(arg.invoke_key(), "sizeKb");
assert_eq!(CommandArg::new("name", "String", true).invoke_key(), "name");

pub fn invoke_key(&self) -> &str

The key to pass this argument under in an IPC call.

pub fn with_schema(self, schema: Value) -> Self

Attaches a JSON Schema describing the argument’s expected shape.

Trait Implementations

impl Clone for CommandArg

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandArg

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CommandArg

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for CommandArg

impl PartialEq for CommandArg

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CommandArg

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CommandArg