Skip to main content

ModuleId

Struct ModuleId 

Source
pub struct ModuleId(/* private fields */);
Expand description

Unique identifier for a loadable module.

Convention: Use kebab-case names like “lang-rust”, “feat-completion”.

§Static vs Dynamic IDs

Module IDs can be either:

  • Static (&'static str): For compile-time known modules, use ModuleId::new()
  • Dynamic (String): For runtime-generated modules, use ModuleId::from_string()

Static IDs are preferred for performance (no allocation), but dynamic IDs allow for user-defined or plugin-loaded modules with arbitrary names.

§Example

use reovim_kernel::api::v1::ModuleId;

// Static ID (compile-time known)
let static_id = ModuleId::new("lang-rust");

// Dynamic ID (runtime generated)
let name = format!("user-plugin-{}", 42);
let dynamic_id = ModuleId::from_string(name);

// Both work the same way
assert_eq!(static_id.as_str(), "lang-rust");
assert_eq!(dynamic_id.as_str(), "user-plugin-42");

Implementations§

Source§

impl ModuleId

Source

pub const fn new(id: &'static str) -> Self

Create a new module identifier from a static string.

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

Source

pub fn from_string(id: String) -> Self

Create a module identifier from an owned String.

Use this for dynamically-generated module IDs (e.g., user plugins, runtime-loaded modules with user-provided names).

Source

pub fn as_str(&self) -> &str

Get the identifier string.

Source

pub const fn is_static(&self) -> bool

Check if this is a static (borrowed) ID.

Source

pub const fn is_dynamic(&self) -> bool

Check if this is a dynamic (owned) ID.

Trait Implementations§

Source§

impl Clone for ModuleId

Source§

fn clone(&self) -> ModuleId

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 ModuleId

Source§

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

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

impl Display for ModuleId

Source§

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

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

impl From<&'static str> for ModuleId

Source§

fn from(s: &'static str) -> Self

Converts to this type from the input type.
Source§

impl From<String> for ModuleId

Source§

fn from(s: String) -> Self

Converts to this type from the input type.
Source§

impl Hash for ModuleId

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 ModuleId

Source§

fn eq(&self, other: &ModuleId) -> 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 ModuleId

Source§

impl StructuralPartialEq for ModuleId

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.