Skip to main content

RootMenu

Struct RootMenu 

Source
pub struct RootMenu {
    pub source: &'static str,
    pub chord: Option<&'static str>,
    pub action: &'static str,
    pub doc: &'static str,
}
Expand description

dispatch_transient with the gates supplied rather than probed — pure, and the form every guard over this menu uses. MG.49: one root menu — reachable from the dispatch and from its own chord.

Emacs binds these on magit-mode-map, the parent keymap every magit-derived mode inherits, so z opens stash from the log buffer and the diff buffer as much as from status. magit-core-mode is the same shape here, which is why the chords live there rather than on magit-status-mode.

Chords follow evil-collection-magit, the reference this crate already uses for gr / O / x — so push is p, not magit’s P (p is free in a read-only buffer; P is not, being paste).

Fields§

§source: &'static str

Registered TransientSourceRegistry name, and the string the chord’s Effect::OpenTransient names.

§chord: Option<&'static str>

The chord magit-core-mode binds, or None when the key is a live vim chord in a read-only buffer and the menu is reachable only through the dispatch.

This is the constraint emacs does not have. Magit binds all seventeen on magit-mode-map because emacs is not modal. Here a minor-mode layer beats the builtin vim layer, so binding f would take find-char away inside every magit buffer — and a magit buffer is text you navigate. Vim’s grammar IS the public command API (paramount goal #3), so it wins: only keys whose vim meaning is an editing operator — inert where nothing is editable — are free to take.

§action: &'static str

The action the chord fires.

§doc: &'static str

Keymap documentation.

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.

§

impl<T> Instrument for T

§

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

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

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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