Skip to main content

SplitViewState

Struct SplitViewState 

Source
pub struct SplitViewState {
    pub active_buffer: BufferId,
    pub keyed_states: HashMap<BufferId, BufferViewState>,
    pub open_buffers: Vec<BufferId>,
    pub tab_scroll_offset: usize,
    pub layout: Option<Layout>,
    pub layout_dirty: bool,
    pub focus_history: Vec<BufferId>,
    pub sync_group: Option<u32>,
    pub composite_view: Option<BufferId>,
}
Expand description

Per-split view state (independent of buffer content)

Following the Emacs model where each window (split) has its own:

  • Point (cursor position) - independent per split
  • Window-start (scroll position) - independent per split
  • Tabs (open buffers) - independent per split

Buffer-specific state (cursors, viewport, view_mode, compose settings) is stored in the keyed_states map, keyed by BufferId. The active buffer’s state is accessible via Deref/DerefMut (so vs.cursors transparently accesses the active buffer’s cursors), or explicitly via active_state()/active_state_mut().

Fields§

§active_buffer: BufferId

Which buffer is currently active in this split

§keyed_states: HashMap<BufferId, BufferViewState>

Per-buffer view state map. The active buffer always has an entry.

§open_buffers: Vec<BufferId>

List of buffer IDs open in this split’s tab bar (in order) The currently displayed buffer is tracked in the SplitNode::Leaf

§tab_scroll_offset: usize

Horizontal scroll offset for the tabs in this split

§layout: Option<Layout>

Computed layout for this view (from view_transform or base tokens) This is View state - each split has its own Layout

§layout_dirty: bool

Whether the layout needs to be rebuilt (buffer changed, transform changed, etc.)

§focus_history: Vec<BufferId>

Focus history stack for this split (most recent at end) Used for “Switch to Previous Tab” and for returning to previous buffer when closing

§sync_group: Option<u32>

Sync group ID for synchronized scrolling Splits with the same sync_group will scroll together

§composite_view: Option<BufferId>

When set, this split renders a composite view (e.g., side-by-side diff). The split’s buffer_id is the focused source buffer, but rendering uses the composite layout. This makes the source buffer the “active buffer” so normal keybindings work directly.

Implementations§

Source§

impl SplitViewState

Source

pub fn with_buffer(width: u16, height: u16, buffer_id: BufferId) -> Self

Create a new split view state with an initial buffer open

Source

pub fn active_state(&self) -> &BufferViewState

Get the active buffer’s view state

Source

pub fn active_state_mut(&mut self) -> &mut BufferViewState

Get a mutable reference to the active buffer’s view state

Source

pub fn switch_buffer(&mut self, new_buffer_id: BufferId)

Switch the active buffer in this split.

If the new buffer has a saved state in keyed_states, it is restored. Otherwise a default BufferViewState is created with the split’s current viewport dimensions.

Source

pub fn buffer_state(&self, buffer_id: BufferId) -> Option<&BufferViewState>

Get the view state for a specific buffer (if it exists)

Source

pub fn buffer_state_mut( &mut self, buffer_id: BufferId, ) -> Option<&mut BufferViewState>

Get a mutable reference to the view state for a specific buffer (if it exists)

Source

pub fn ensure_buffer_state( &mut self, buffer_id: BufferId, ) -> &mut BufferViewState

Ensure a buffer has keyed state, creating a default if needed. Returns a mutable reference to the buffer’s view state.

Source

pub fn remove_buffer_state(&mut self, buffer_id: BufferId)

Remove keyed state for a buffer (when buffer is closed from this split)

Source

pub fn invalidate_layout(&mut self)

Mark layout as needing rebuild (call after buffer changes)

Source

pub fn ensure_layout( &mut self, tokens: &[ViewTokenWire], source_range: Range<usize>, tab_size: usize, ) -> &Layout

Ensure layout is valid, rebuilding if needed. Returns the Layout - never returns None. Following VSCode’s ViewModel pattern.

§Arguments
  • tokens - ViewTokenWire array (from view_transform or built from buffer)
  • source_range - The byte range this layout covers
  • tab_size - Tab width for rendering
Source

pub fn get_layout(&self) -> Option<&Layout>

Get the current layout if it exists and is valid

Source

pub fn add_buffer(&mut self, buffer_id: BufferId)

Add a buffer to this split’s tabs (if not already present)

Source

pub fn remove_buffer(&mut self, buffer_id: BufferId)

Remove a buffer from this split’s tabs and clean up its keyed state

Source

pub fn has_buffer(&self, buffer_id: BufferId) -> bool

Check if a buffer is open in this split

Source

pub fn push_focus(&mut self, buffer_id: BufferId)

Push a buffer to the focus history (LRU-style) If the buffer is already in history, it’s moved to the end

Source

pub fn previous_buffer(&self) -> Option<BufferId>

Get the most recently focused buffer (without removing it)

Source

pub fn pop_focus(&mut self) -> Option<BufferId>

Pop the most recent buffer from focus history

Source

pub fn remove_from_history(&mut self, buffer_id: BufferId)

Remove a buffer from the focus history (called when buffer is closed)

Methods from Deref<Target = BufferViewState>§

Source

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.

Source

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

Apply editor config defaults for display settings.

Sets show_line_numbers, line_wrap, 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.

Trait Implementations§

Source§

impl Clone for SplitViewState

Source§

fn clone(&self) -> SplitViewState

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SplitViewState

Source§

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

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

impl Deref for SplitViewState

Source§

type Target = BufferViewState

The resulting type after dereferencing.
Source§

fn deref(&self) -> &BufferViewState

Dereferences the value.
Source§

impl DerefMut for SplitViewState

Source§

fn deref_mut(&mut self) -> &mut BufferViewState

Mutably dereferences the value.

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
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<'a, T> FromIn<'a, T> for T

Source§

fn from_in(t: T, _: &'a Allocator) -> T

Converts to this type from the input type within the given allocator.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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<'a, T, U> IntoIn<'a, U> for T
where U: FromIn<'a, T>,

Source§

fn into_in(self, allocator: &'a Allocator) -> U

Converts this type into the (usually inferred) input type within the given allocator.
Source§

impl<D> OwoColorize for D

Source§

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more
Source§

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more
Source§

fn black(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black
Source§

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

Change the background color to black
Source§

fn red(&self) -> FgColorDisplay<'_, Red, Self>

Change the foreground color to red
Source§

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

Change the background color to red
Source§

fn green(&self) -> FgColorDisplay<'_, Green, Self>

Change the foreground color to green
Source§

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Change the background color to green
Source§

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

Change the foreground color to yellow
Source§

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

Change the background color to yellow
Source§

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

Change the foreground color to blue
Source§

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

Change the background color to blue
Source§

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to magenta
Source§

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to magenta
Source§

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to purple
Source§

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to purple
Source§

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

Change the foreground color to cyan
Source§

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

Change the background color to cyan
Source§

fn white(&self) -> FgColorDisplay<'_, White, Self>

Change the foreground color to white
Source§

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

Change the background color to white
Source§

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

Change the foreground color to the terminal default
Source§

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

Change the background color to the terminal default
Source§

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

Change the foreground color to bright black
Source§

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

Change the background color to bright black
Source§

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

Change the foreground color to bright red
Source§

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

Change the background color to bright red
Source§

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

Change the foreground color to bright green
Source§

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

Change the background color to bright green
Source§

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Change the foreground color to bright yellow
Source§

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

Change the background color to bright yellow
Source§

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Change the foreground color to bright blue
Source§

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

Change the background color to bright blue
Source§

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright magenta
Source§

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright magenta
Source§

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright purple
Source§

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright purple
Source§

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

Change the foreground color to bright cyan
Source§

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

Change the background color to bright cyan
Source§

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

Change the foreground color to bright white
Source§

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Change the background color to bright white
Source§

fn bold(&self) -> BoldDisplay<'_, Self>

Make the text bold
Source§

fn dimmed(&self) -> DimDisplay<'_, Self>

Make the text dim
Source§

fn italic(&self) -> ItalicDisplay<'_, Self>

Make the text italicized
Source§

fn underline(&self) -> UnderlineDisplay<'_, Self>

Make the text underlined
Make the text blink
Make the text blink (but fast!)
Source§

fn reversed(&self) -> ReversedDisplay<'_, Self>

Swap the foreground and background colors
Source§

fn hidden(&self) -> HiddenDisplay<'_, Self>

Hide the text
Source§

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

Cross out the text
Source§

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more
Source§

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more
Source§

fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.
Source§

fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.
Source§

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.
Source§

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.
Source§

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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> TryClone for T
where T: Clone,

Source§

fn try_clone(&self) -> Result<T, Error>

Clones self, possibly returning an error.
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ParallelSend for T