Skip to main content

BufferView

Struct BufferView 

Source
pub struct BufferView<'a, R: StyleResolver> {
    pub buffer: &'a Buffer,
    pub selection: Option<Selection>,
    pub resolver: &'a R,
    pub cursor_line_bg: Style,
    pub cursor_column_bg: Style,
    pub selection_bg: Style,
    pub cursor_style: Style,
    pub gutter: Option<Gutter>,
    pub search_bg: Style,
    pub signs: &'a [Sign],
    pub conceals: &'a [Conceal],
}
Expand description

Render-time wrapper around &Buffer that carries the optional Selection + a StyleResolver. Created per draw, dropped when the frame is done — cheap, holds only refs.

Fields§

§buffer: &'a Buffer§selection: Option<Selection>§resolver: &'a R§cursor_line_bg: Style

Bg painted across the cursor row (vim’s cursorline). Pass Style::default() to disable.

§cursor_column_bg: Style

Bg painted down the cursor column (vim’s cursorcolumn). Pass Style::default() to disable.

§selection_bg: Style

Bg painted under selected cells. Composed over syntax fg.

§cursor_style: Style

Style for the cursor cell. REVERSED is the conventional choice; works against any theme.

§gutter: Option<Gutter>

Optional left-side line-number gutter. width includes the trailing space separating the number from text. Pass None to disable. Numbers are 1-based, right-aligned.

§search_bg: Style

Bg painted under cells covered by an active / search match (read from Buffer::search_pattern). Style::default() to disable.

§signs: &'a [Sign]

Per-row gutter signs (LSP diagnostic dots, git diff markers, …). Painted into the leftmost gutter column after the line number, so they overwrite the leading space tui-style gutters reserve. Highest-priority sign per row wins.

§conceals: &'a [Conceal]

Per-row substitutions applied at render time. Each conceal hides the byte range [start_byte, end_byte) and paints replacement in its place. Empty slice = no conceals.

Trait Implementations§

Source§

impl<R: StyleResolver> Widget for BufferView<'_, R>

Source§

fn render(self, area: Rect, term_buf: &mut TermBuffer)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom widget.

Auto Trait Implementations§

§

impl<'a, R> Freeze for BufferView<'a, R>

§

impl<'a, R> RefUnwindSafe for BufferView<'a, R>
where R: RefUnwindSafe,

§

impl<'a, R> Send for BufferView<'a, R>
where R: Sync,

§

impl<'a, R> Sync for BufferView<'a, R>
where R: Sync,

§

impl<'a, R> Unpin for BufferView<'a, R>

§

impl<'a, R> UnsafeUnpin for BufferView<'a, R>

§

impl<'a, R> UnwindSafe for BufferView<'a, R>
where R: RefUnwindSafe,

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, 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
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.