Skip to main content

BufferDisplayCategory

Enum BufferDisplayCategory 

Source
pub enum BufferDisplayCategory {
    LspStatus,
    LspLog,
    Messages,
    HelpTopic,
    HelpDescribe,
    HelpApropos,
    HelpList,
    Hover,
    Signature,
    PickerResult,
}
Expand description

Per-feature display preference. Each command that produces a buffer carries its category; the App resolves the category to a BufferDisplay via default_display (today) or a user-supplied override (follow-up).

Granularity rationale: per-command is too narrow (six :describe-* variants would need six knobs); per-BufferKind is too coarse (every help-flavoured surface is Help, but hover and :lsp-log have wildly different display intents). Per-category groups commands that share intent, which is what users actually configure.

Multiple-choice surfaces (:diagnostics, :references, :symbol, :Files, :buffers) are picker-shaped by design – the user picks one of N candidates – and don’t have a category here. Their picker UI is a fixed surface; where the selected result lands is governed by Self::PickerResult. The categories below all describe dedicated single-buffer outputs.

Variants§

§

LspStatus

:lsp-status – one-shot read of the supervisor state.

§

LspLog

:lsp-log / :lsp-trace-log – live-tailed log views the user wants to keep around. (:lsp-server-log is a picker; it routes through Self::PickerResult once the user picks a server, then the chosen log opens under LspLog.)

§

Messages

:messages – chronological transcript of every echo area message (analogue of emacs’s *Messages*). Live-tailed via the MessagesRing; opens in the active pane by default.

§

HelpTopic

:help <topic> – free-form help docs.

§

HelpDescribe

:describe-command/-buffer/-key/-option/-mode/-event – introspection-driven help.

§

HelpApropos

:apropos <pattern> – search command names + docs.

§

HelpList

:ls, :keymap, :marks, :registers, :options – state-listing help views.

§

Hover

K – inline hover / quick-info popup. Auto-dismisses on cursor motion.

§

Signature

Signature help – argument-list popup that follows the cursor as the user types args.

§

PickerResult

Where the selected buffer / location lands after the user accepts a picker entry. Used by :diagnostics / :references / :symbol / :Files / :buffers / :lsp-server-log – their picker UI is fixed; this knob controls the post-accept buffer placement.

Trait Implementations§

Source§

impl Clone for BufferDisplayCategory

Source§

fn clone(&self) -> BufferDisplayCategory

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for BufferDisplayCategory

Source§

impl Debug for BufferDisplayCategory

Source§

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

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

impl Eq for BufferDisplayCategory

Source§

impl Hash for BufferDisplayCategory

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 BufferDisplayCategory

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for BufferDisplayCategory

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
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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, 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.