Struct ModeId 

pub struct ModeId(/* private fields */);

Canonical identity of a mode. Interned-string for Copy + Eq + Hash at zero allocation cost on the hot path.

Two ModeIds are equal iff their names are equal; equality is pointer-cheap because internment::Intern<String> deduplicates at construction. Across crates, the identity is the string, not a Rust type – this is intentional, since lifecycle events and registry lookups are uniform across built-in and plugin modes (mode-architecture.md §1, “modes are an interface, not a distribution unit”).

Naming convention: mode names always end in -mode. Group names (M.2) never end in -mode. The disambiguation rule in mode-architecture.md §6.7.1 depends on this convention.

Ord compares the names (alphabetical), not intern addresses, so orderings built from it are stable across runs.

Examples

use lattice_keymap::ModeId;

let a = ModeId::new("diff-mode");
assert_eq!(a, ModeId::new("diff-mode"));
assert_eq!(a.as_str(), "diff-mode");
assert!(a < ModeId::new("magit-mode"));

Implementations

impl ModeId

pub fn new(name: &str) -> Self

Intern name. Two calls with equal strings produce equal ModeIds; the underlying allocation is shared.

pub fn as_str(&self) -> &str

Borrow the canonical name. Stable for the program’s lifetime.

Trait Implementations

impl Clone for ModeId

fn clone(&self) -> ModeId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ModeId

impl Debug for ModeId

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

Formats the value using the given formatter.

impl Display for ModeId

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

Formats the value using the given formatter.

impl Eq for ModeId

impl Hash for ModeId

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ModeId

fn cmp(&self, other: &ModeId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ModeId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ModeId

fn partial_cmp(&self, other: &ModeId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for ModeId