Skip to main content

SplitManager

Struct SplitManager 

Source
pub struct SplitManager { /* private fields */ }
Expand description

Manager for the split view system

Implementations§

Source§

impl SplitManager

Source

pub fn new(buffer_id: BufferId) -> Self

Create a new split manager with a single buffer

Source

pub fn root(&self) -> &SplitNode

Get the root split node

Source

pub fn allocate_split_id(&mut self) -> SplitId

Allocate a new unique split ID

Source

pub fn replace_root(&mut self, new_root: SplitNode, new_active: LeafId)

Replace the root split tree. The new tree must have unique IDs (allocated via allocate_split_id). The caller must also provide the new active leaf ID.

Source

pub fn active_split(&self) -> LeafId

Get the currently active split ID

Source

pub fn set_active_split(&mut self, split_id: LeafId) -> bool

Set the active split (must be a leaf)

Source

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

Get the buffer ID of the active split (if it’s a leaf)

Source

pub fn get_buffer_id(&self, split_id: SplitId) -> Option<BufferId>

Get the buffer ID for a specific split (if it’s a leaf)

Source

pub fn set_active_buffer_id(&mut self, new_buffer_id: BufferId) -> bool

Update the buffer ID of the active split

Source

pub fn set_split_buffer(&mut self, leaf_id: LeafId, new_buffer_id: BufferId)

Update the buffer ID of a specific leaf split

Source

pub fn split_active( &mut self, direction: SplitDirection, new_buffer_id: BufferId, ratio: f32, ) -> Result<LeafId, String>

Split the currently active pane

Source

pub fn split_active_before( &mut self, direction: SplitDirection, new_buffer_id: BufferId, ratio: f32, ) -> Result<LeafId, String>

Split the active pane, placing the new buffer before (left/top) the existing content. ratio still controls the first child’s proportion of space.

Source

pub fn split_active_positioned( &mut self, direction: SplitDirection, new_buffer_id: BufferId, ratio: f32, before: bool, ) -> Result<LeafId, String>

Source

pub fn split_root_positioned( &mut self, direction: SplitDirection, new_buffer_id: BufferId, ratio: f32, before: bool, ) -> Result<LeafId, String>

Split the root of the tree (rather than the active leaf), so the new leaf becomes a sibling of the entire existing layout. Used by the Utility Dock so the dock spans the full width below any pre-existing horizontal-axis splits, instead of nesting under whichever pane happened to be active.

ratio controls the first child’s proportion. before = false places the new leaf after (right/bottom) the existing root.

Source

pub fn close_split(&mut self, split_id: LeafId) -> Result<(), String>

Close a split pane (if not the last one)

Source

pub fn remove_grouped(&mut self, target: LeafId) -> Result<(), String>

Remove a Grouped node from the tree by its split_id. Unlike close_split which requires a leaf, this removes a whole Grouped subtree (tab) from the split structure. The Grouped node is replaced with… well, nothing — so this can only succeed if the Grouped is inside a Split (so we can replace the Split with its sibling) or if the root itself is the Grouped (which we can’t remove without a replacement).

Source

pub fn adjust_ratio(&mut self, container_id: ContainerId, delta: f32)

Adjust the split ratio of a container

Source

pub fn parent_container_of(&self, leaf_id: LeafId) -> Option<ContainerId>

Find the parent container of a leaf

Source

pub fn get_visible_buffers( &self, viewport_rect: Rect, ) -> Vec<(LeafId, BufferId, Rect)>

Get all visible buffer views with their rectangles

Source

pub fn get_separators( &self, viewport_rect: Rect, ) -> Vec<(SplitDirection, u16, u16, u16)>

Get all split separator positions for rendering borders Returns (direction, x, y, length) tuples

Source

pub fn get_separators_with_ids( &self, viewport_rect: Rect, ) -> Vec<(ContainerId, SplitDirection, u16, u16, u16)>

Get all split separator positions with their split IDs (for mouse hit testing) Returns (container_id, direction, x, y, length) tuples

Source

pub fn get_ratio(&self, split_id: SplitId) -> Option<f32>

Get the current ratio of a split container

Source

pub fn set_ratio(&mut self, container_id: ContainerId, new_ratio: f32)

Set the exact ratio of a split container

Source

pub fn set_fixed_size( &mut self, container_id: ContainerId, first: Option<u16>, second: Option<u16>, )

Set a fixed size on a split container’s first or second child. When set, the child gets exactly this many rows/cols instead of using the ratio.

Source

pub fn distribute_splits_evenly(&mut self)

Distribute all visible splits evenly This sets the ratios of all container splits so that leaf splits get equal space

Source

pub fn next_split(&mut self)

Navigate to the next split (circular)

Source

pub fn prev_split(&mut self)

Navigate to the previous split (circular)

Source

pub fn splits_for_buffer(&self, target_buffer_id: BufferId) -> Vec<LeafId>

Get all split IDs that display a specific buffer

Source

pub fn buffer_for_split(&self, target_split_id: LeafId) -> Option<BufferId>

Get the buffer ID for a specific leaf split

Source

pub fn maximize_split(&mut self) -> Result<(), String>

Maximize the active split (hide all other splits temporarily) Returns Ok(()) if successful, Err if there’s only one split

Source

pub fn unmaximize_split(&mut self) -> Result<(), String>

Unmaximize the currently maximized split (restore all splits) Returns Ok(()) if successful, Err if no split is maximized

Source

pub fn is_maximized(&self) -> bool

Check if a split is currently maximized

Source

pub fn maximized_split(&self) -> Option<SplitId>

Get the currently maximized split ID (if any)

Source

pub fn toggle_maximize(&mut self) -> Result<bool, String>

Toggle maximize state for the active split If maximized, unmaximize. If not maximized, maximize. Returns true if maximized, false if ununmaximized.

Source

pub fn get_splits_in_group( &self, group_id: u32, view_states: &HashMap<LeafId, SplitViewState>, ) -> Vec<LeafId>

Get all leaf split IDs that belong to a specific sync group

Source

pub fn set_label(&mut self, split_id: LeafId, label: String)

Set a label on a leaf split (e.g., “sidebar”)

Source

pub fn clear_label(&mut self, split_id: SplitId)

Remove a label from a split

Source

pub fn get_label(&self, split_id: SplitId) -> Option<&str>

Get the label for a split (if any)

Source

pub fn labels(&self) -> &HashMap<SplitId, String>

Get all split labels (for workspace serialization)

Source

pub fn set_leaf_role(&mut self, split_id: LeafId, new_role: Option<SplitRole>)

Set the role tag on a leaf. No-op if split_id is not a leaf. Caller is responsible for the “at most one leaf per role” invariant — call clear_role on the previous holder first.

Source

pub fn find_leaf_by_role(&self, target: SplitRole) -> Option<LeafId>

Find the unique leaf carrying the given role, if any.

Source

pub fn clear_role(&mut self, target: SplitRole) -> Option<LeafId>

Clear any leaf currently carrying the given role. Returns the leaf id whose role was cleared, if one was found. Used to enforce the “at most one leaf per role” invariant when transferring a role.

Source

pub fn find_split_by_label(&self, label: &str) -> Option<LeafId>

Find the first leaf split with the given label

Source

pub fn find_unlabeled_leaf(&self) -> Option<LeafId>

Find the first leaf split without a label

Trait Implementations§

Source§

impl Debug for SplitManager

Source§

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

Formats the value using the given formatter. Read more

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> 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 + Sync + Send>

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> 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<T> Same for T

Source§

type Output = T

Should always be Self
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