Skip to main content

BufferDisplayPreference

Enum BufferDisplayPreference 

Source
pub enum BufferDisplayPreference {
    Default,
    PopupCentered,
    PopupCursor,
    FloatingCursor,
    ActivePane,
    SplitHorizontal,
    SplitVertical,
}
Expand description

User-facing override for a BufferDisplay. Each BufferDisplayCategory gets a typed option keyed <category>.display whose value is one of these variants; the App’s resolver maps the variant to the matching BufferDisplay. Default means “use the built-in default for this category” — the fallback when the user hasn’t set the option explicitly.

Flat (non-parametric) shape so the typed-options system can store + parse it as one scalar; the parametric BufferDisplay variants (Popup(PopupPlacement), Split(SplitOrientation)) are flattened here as PopupCentered / PopupCursor / SplitHorizontal / SplitVertical.

Slice 3c.unify.option-docs-builtin migrated this enum to labeled_enum! — adding a new display preference is now one line; label / parse_label / doc / all are derived automatically.

Variants§

§

Default

The implicit value when no override has been set.

§

PopupCentered

Centred focused popup (focus moves into the popup). Accepts popup as an alias of popup-centered.

§

PopupCursor

Focused popup anchored at the cursor.

§

FloatingCursor

Doc keeps focus, popup auto-dismisses on cursor motion (the hover shape). floating is the canonical short alias.

§

ActivePane

Swap the buffer into the active pane. Alias pane.

§

SplitHorizontal

Horizontal split (new pane below). Aliases split, split-horizontal.

§

SplitVertical

Vertical split (new pane beside). Alias split-vertical.

Implementations§

Source§

impl BufferDisplayPreference

Source

pub fn label(self) -> &'static str

Canonical string label.

Source

pub fn doc(self) -> &'static str

Short marginalia doc shown in cmdline-completion’s right-aligned column.

Source

pub fn all() -> &'static [Self]

Variants in declaration order.

Source

pub fn parse_label(s: &str) -> Result<Self, String>

Parse from canonical label or any registered alias.

Source§

impl BufferDisplayPreference

Source

pub fn resolve(self, category: BufferDisplayCategory) -> BufferDisplay

Map to the concrete BufferDisplay for the given category. Default falls through to default_display; any explicit variant returns its fixed shape.

§Examples
use lattice_core::ui::display::{
    BufferDisplay, BufferDisplayCategory, BufferDisplayPreference,
};

// No override: hover keeps its built-in floating popup.
assert_eq!(
    BufferDisplayPreference::Default.resolve(BufferDisplayCategory::Hover),
    BufferDisplay::FLOATING_CURSOR,
);
// `:set lsp.log.display=split` — the alias parses, then resolves.
let pref = BufferDisplayPreference::parse_label("split")
    .unwrap_or_default();
assert_eq!(
    pref.resolve(BufferDisplayCategory::LspLog),
    BufferDisplay::SPLIT_HORIZONTAL,
);

Trait Implementations§

Source§

impl Clone for BufferDisplayPreference

Source§

fn clone(&self) -> BufferDisplayPreference

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 BufferDisplayPreference

Source§

impl Debug for BufferDisplayPreference

Source§

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

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

impl Default for BufferDisplayPreference

Source§

fn default() -> BufferDisplayPreference

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

impl Eq for BufferDisplayPreference

Source§

impl PartialEq for BufferDisplayPreference

Source§

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

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.