Skip to main content

BufferDisplay

Enum BufferDisplay 

Source
pub enum BufferDisplay {
    Popup(PopupPlacement),
    FloatingPopup(PopupPlacement),
    ActivePane,
    Split(SplitOrientation),
}
Expand description

Where to put a buffer the App is about to display.

Renderer-agnostic: a future GPUI / web renderer maps these variants to its own surfaces. The TUI maps Popup to the existing centred-or-anchored overlay, FloatingPopup to the hover-style overlay (popup floats; the doc keeps focus), ActivePane to the :lsp-log-style swap-active-pane path, and Split to a horizontal / vertical split via the pane tree.

Variants§

§

Popup(PopupPlacement)

Focused overlay – the popup gains focus, the underlying document is paused. Used by :lsp-status / :describe-* / :apropos / etc. Carries its own placement (cursor-anchored vs centred).

§

FloatingPopup(PopupPlacement)

Floating overlay – the popup paints on top, but the document keeps focus. Cursor motion in the doc auto-dismisses (via the hover-mode minor contract). Used by hover (K) and signature help.

§

ActivePane

Replace the active pane’s buffer with this one. The previous buffer stays in the registry; pane history / <C-^> (post v1) returns to it.

§

Split(SplitOrientation)

Split the active pane (orientation-dependent) and open the buffer in the new pane. The new pane gains focus, matching vim’s :help / :vert help.

Implementations§

Source§

impl BufferDisplay

Source

pub const POPUP_CENTERED: Self

Focused popup centred in the frame.

Source

pub const POPUP_CURSOR: Self

Focused popup anchored at the cursor.

Source

pub const FLOATING_CURSOR: Self

Unfocused hover-style popup anchored at the cursor.

Source

pub const SPLIT_HORIZONTAL: Self

New pane below the active one (vim :split).

Source

pub const SPLIT_VERTICAL: Self

New pane beside the active one (vim :vsplit).

Trait Implementations§

Source§

impl Clone for BufferDisplay

Source§

fn clone(&self) -> BufferDisplay

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 BufferDisplay

Source§

impl Debug for BufferDisplay

Source§

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

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

impl Eq for BufferDisplay

Source§

impl PartialEq for BufferDisplay

Source§

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

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.