Skip to main content

LeaderKeyProvider

Struct LeaderKeyProvider 

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

Provider for the leader key notation.

Personality modules call set during init() to declare their leader key (e.g., "<Space>" for vim). Bootstrap calls get after all modules have loaded and expands <leader> in keybinding strings.

The stored value is &'static str because all call sites are personality module init() methods passing compile-time string literals. This matches the KeybindingRegistration.keys lifetime requirement.

If multiple personality modules are loaded, the last writer wins and a warning should be logged by the caller.

Implementations§

Source§

impl LeaderKeyProvider

Source

pub const fn new() -> Self

Create a new empty provider.

Source

pub fn set(&self, key: &'static str) -> Option<&'static str>

Set the leader key notation. Called by personality modules during init().

The key parameter is a key notation string (e.g., "<Space>") that will replace <leader> tokens in keybinding key strings.

Returns the previous notation if one was already set.

Source

pub fn get(&self) -> Option<&'static str>

Get the registered leader key notation, if any.

Source

pub fn expand(&self, keys: &str) -> String

Expand <leader> tokens in a key string using the stored notation.

Returns the original string (owned) if no leader key is registered or if the input contains no <leader> token.

Trait Implementations§

Source§

impl Default for LeaderKeyProvider

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Service for LeaderKeyProvider

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, 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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more