Skip to main content

CommandMeta

Struct CommandMeta 

Source
pub struct CommandMeta {
    pub title: Arc<str>,
    pub description: Option<Arc<str>>,
    pub category: Option<Arc<str>>,
    pub keywords: Vec<Arc<str>>,
    pub default_keybindings: Vec<DefaultKeybinding>,
    pub when: Option<WhenExpr>,
    pub os_action: Option<OsAction>,
    pub scope: CommandScope,
    pub hidden: bool,
    pub repeatable: bool,
}
Expand description

Metadata describing a command (title, keybindings, visibility, routing scope).

Fields§

§title: Arc<str>§description: Option<Arc<str>>§category: Option<Arc<str>>§keywords: Vec<Arc<str>>§default_keybindings: Vec<DefaultKeybinding>§when: Option<WhenExpr>§os_action: Option<OsAction>§scope: CommandScope§hidden: bool§repeatable: bool

Implementations§

Source§

impl CommandMeta

Source

pub fn new(title: impl Into<Arc<str>>) -> Self

Source

pub fn with_description(self, description: impl Into<Arc<str>>) -> Self

Source

pub fn with_category(self, category: impl Into<Arc<str>>) -> Self

Source

pub fn with_keywords( self, keywords: impl IntoIterator<Item = impl Into<Arc<str>>>, ) -> Self

Source

pub fn with_default_keybindings( self, bindings: impl IntoIterator<Item = DefaultKeybinding>, ) -> Self

Source

pub fn with_when(self, when: WhenExpr) -> Self

Source

pub fn with_os_action(self, os_action: OsAction) -> Self

Source

pub fn with_scope(self, scope: CommandScope) -> Self

Source

pub fn hidden(self) -> Self

Source

pub fn repeatable(self) -> Self

Trait Implementations§

Source§

impl Clone for CommandMeta

Source§

fn clone(&self) -> CommandMeta

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CommandMeta

Source§

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

Formats the value using the given formatter. 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> 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.