Skip to main content

CommandId

Struct CommandId 

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

Namespaced command identifier.

Commands are identified by their owning module and a local name. This prevents naming conflicts between modules.

§Example

use reovim_kernel::api::v1::{CommandId, ModuleId};

let editor_module = ModuleId::new("editor");
let cursor_down = CommandId::new(editor_module.clone(), "cursor-down");
let cursor_up = CommandId::new(editor_module, "cursor-up");

assert_eq!(cursor_down.name(), "cursor-down");
assert_ne!(cursor_down, cursor_up);

Implementations§

Source§

impl CommandId

Source

pub const fn new(module: ModuleId, name: &'static str) -> Self

Create a new command identifier from static strings.

This is the preferred way to create command IDs for statically-known commands. It’s a const fn and involves no allocation.

Source

pub fn from_owned(module: ModuleId, name: String) -> Self

Create a command identifier from owned strings.

Use this for dynamically-generated command IDs (e.g., picker selections, FFI calls, manifest parsing).

Source

pub fn from_qualified(qualified: String) -> Self

Create a command identifier from a qualified string like “module:command”.

This method is intended for dynamic use cases like FFI where command IDs are specified as strings at runtime.

If the string doesn’t contain ‘:’, the entire string is treated as the command name with “unknown” as the module.

§Example
use reovim_kernel::api::v1::CommandId;

let cmd = CommandId::from_qualified("editor:cursor-down".to_string());
assert_eq!(cmd.module().as_str(), "editor");
assert_eq!(cmd.name(), "cursor-down");
Source

pub const fn module(&self) -> &ModuleId

Get the owning module.

Source

pub fn name(&self) -> &str

Get the local name.

Source

pub fn name_owned(&self) -> Cow<'static, str>

Get the local name as an owned Cow.

Use this when you need a value that isn’t tied to the CommandId’s lifetime (e.g., when calling .id().name_owned() on a temporary).

Trait Implementations§

Source§

impl Clone for CommandId

Source§

fn clone(&self) -> CommandId

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 CommandId

Source§

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

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

impl Display for CommandId

Source§

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

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

impl Hash for CommandId

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for CommandId

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for CommandId

Source§

impl StructuralPartialEq for CommandId

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.