Struct BufferViewState 

pub struct BufferViewState {
    pub cursors: Cursors,
    pub viewport: Viewport,
    pub view_mode: ViewMode,
    pub compose_width: Option<u16>,
    pub compose_column_guides: Option<Vec<u16>>,
    pub rulers: Vec<usize>,
    pub show_line_numbers: bool,
    pub highlight_current_line: bool,
    pub view_transform: Option<ViewTransformPayload>,
    pub view_transform_stale: bool,
    pub plugin_state: HashMap<String, Value>,
    pub folds: FoldManager,
}

Per-buffer view state within a split.

Each buffer opened in a split gets its own BufferViewState stored in the split’s keyed_states map. This ensures that switching buffers within a split preserves cursor position, scroll state, view mode, and compose settings independently for each buffer.

Fields

cursors: Cursors

Independent cursor set (supports multi-cursor)

viewport: Viewport

Independent scroll position

view_mode: ViewMode

View mode (Source/Compose) for this buffer in this split

compose_width: Option<u16>

Optional compose width for centering/wrapping

compose_column_guides: Option<Vec<u16>>

Column guides (e.g., tables)

rulers: Vec<usize>

Vertical ruler positions (initialized from config, mutable per-buffer)

show_line_numbers: bool

Per-split line number visibility. This is the single source of truth for whether line numbers are shown in this split. Initialized from config when the split is created. Compose mode forces this to false; leaving compose restores from config.

highlight_current_line: bool

Per-split current line highlight visibility. When true, the line containing the cursor gets a distinct background color. Initialized from config when the split is created.

view_transform: Option<ViewTransformPayload>

Optional view transform payload

view_transform_stale: bool

True when the buffer was edited since the last view_transform_request hook fired. While true, incoming SubmitViewTransform commands are rejected as stale (their tokens have source_offsets from before the edit).

plugin_state: HashMap<String, Value>

Plugin-managed state (arbitrary key-value pairs). Plugins can store per-buffer-per-split state here via the setViewState/getViewState API. Persisted across sessions via workspace serialization.

folds: FoldManager

Collapsed folding ranges for this buffer/view.

Implementations

impl BufferViewState

pub fn ensure_cursor_visible( &mut self, buffer: &mut Buffer, marker_list: &MarkerList, )

Resolve fold ranges and ensure the primary cursor is visible.

This is the preferred entry point for all non-rendering callers — it resolves hidden fold byte ranges from the marker list and passes them to viewport.ensure_visible so that line counting skips folded lines.

pub fn new(width: u16, height: u16) -> Self

Create a new buffer view state with defaults

pub fn apply_config_defaults( &mut self, line_numbers: bool, highlight_current_line: bool, line_wrap: bool, wrap_indent: bool, wrap_column: Option<usize>, rulers: Vec<usize>, )

Apply editor config defaults for display settings.

Sets show_line_numbers, highlight_current_line, line_wrap, wrap_column, and rulers from the given config values. Call this after creating a new BufferViewState (via new() or ensure_buffer_state()) to ensure the view respects the user’s settings.

pub fn activate_page_view(&mut self, page_width: Option<usize>)

Activate page view (compose mode) with an optional page width.

This sets the view mode to Compose, disables builtin line wrap (the compose plugin handles wrapping), hides line numbers, and optionally sets the compose width for centering.

Trait Implementations

impl Clone for BufferViewState

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BufferViewState

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

Formats the value using the given formatter.