Struct EditorPanel 

pub struct EditorPanel { /* private fields */ }

Implementations

impl EditorPanel

pub fn perform(&mut self, action: Action) -> Option<Vec<PanelEvent>>

The entry point every consumer uses. None means this panel does not handle the action, so the app should try it.

impl EditorPanel

pub fn from_str(s: &str) -> Self

pub fn from_path(path: &Path) -> Result<Self>

pub fn new_at(path: &Path) -> Self

An empty editor over a file that does not exist yet.

pub fn selections(&self) -> &Selections

pub fn cursor(&self) -> Position

The primary head — where the terminal cursor is drawn.

pub fn top_line(&self) -> usize

pub fn left_col(&self) -> usize

pub fn save(&mut self) -> Result<()>

pub fn matches_disk(&self) -> bool

Whether the file on disk is byte-for-byte what this buffer holds.

This is what makes our own save not come back as an external change: the watcher reports the write we just made, and the answer here is yes, so nothing happens. No mtime bookkeeping, and no window in which a remembered timestamp is stale.

A file that cannot be read at all counts as differing — it has usually just been deleted, which the caller needs to hear about.

pub fn reload(&mut self) -> Result<()>

Replace the buffer with what is on disk, keeping the cursor where it can still go.

Undo history does not survive: it describes edits against a rope that no longer exists, and offering to undo your way back into a file somebody else rewrote is worse than starting clean.

pub fn line_text(&self, line: usize) -> String

Line contents without the trailing newline.

pub fn line_count(&self) -> usize

pub fn path(&self) -> Option<&Path>

pub fn file_name(&self) -> String

The file’s name with no dirty marker on it.

title() is what a panel border shows and carries the *; the status bar draws that state as colour instead, so it needs the bare name.

pub fn is_dirty(&self) -> bool

pub fn line_ending(&self) -> LineEnding

pub fn buffer_find_all(&self, query: &SearchQuery) -> Vec<Selection>

Every match in the buffer.

The app asks through here rather than reaching into self.buffer: a panel’s internals are not application state, which is the same rule RenderContext enforces pointing the other way.

ponytail: this scans the whole buffer — 5.4–8.7 ms on a 50k-line file, re-measured at v0.2.3 against a 16 ms keystroke budget. Fine for answering Enter, too slow to run on every keystroke, and the one budget in the project with less than an order of magnitude of headroom (gap-analysis defect 38).

Ctrl+D already avoids it: TextBuffer::find_next searches from the cursor and stops at the first hit, at 3.89 µs per press. An incremental search box wants the same shape — viewport first, the rest completed off the render thread. See typ-buffer/tests/perf.rs.

pub fn select_range(&mut self, selection: Selection)

Select a range and scroll it into view.

pub fn goto_line(&mut self, line: usize)

Put the caret at the start of a line and centre it in the viewport.

Centred rather than merely scrolled into view: scroll_to_cursor moves the minimum, which after a jump leaves the target line on whichever edge it entered from. That is technically visible and useless — you jumped there to read around it, and half the context is off-screen.

Out-of-range clamps to the last line. Someone typing 9999 means the end of the file, and erroring at them is pedantry rather than correctness.

pub fn replace_all(&mut self, query: &SearchQuery, replacement: &str) -> usize

Replace every match, as one undo step. Returns how many.

Trait Implementations

impl Panel for EditorPanel

fn handle_key(&mut self, _chord: KeyChord) -> Vec<PanelEvent>

The editor has no raw-key behavior left.

Every key that does anything here is a keymap row resolving to an Action, which is the invariant the whole milestone exists to establish: a primitive reachable only from a key handler is invisible to the command palette and to the vim layer. The M1-era arms that used to live here were the last thing violating it.

fn name(&self) -> &'static str

Stable type name, used for registry lookup and session records.

fn title(&self) -> String

Dynamic title shown in the panel header.

fn render(&mut self, area: Rect, buf: &mut Buffer, ctx: &RenderContext<'_>)

fn apply_action(&mut self, action: Action) -> Option<Vec<PanelEvent>>

Perform a named action.

fn cursor_position(&self, panel_area: Rect) -> Option<(u16, u16)>

Where the terminal cursor belongs, in screen coordinates, when this panel holds focus. None hides it.

fn handle_mouse( &mut self, event: MouseEvent, panel_area: Rect, ) -> Vec<PanelEvent>

panel_area is supplied so the panel can translate to local coordinates.

fn handle_scroll(&mut self, delta: i32, _panel_area: Rect) -> Vec<PanelEvent>

Coalesced scroll. Positive is down.

fn needs_close_confirmation(&self) -> Option<String>

Some(message) blocks closing until confirmed.

fn as_any(&self) -> &dyn Any

fn as_any_mut(&mut self) -> &mut dyn Any

fn tick(&mut self) -> Vec<PanelEvent>

Periodic hook for background work.

fn captures_escape(&self) -> bool

True when the panel consumes Escape itself (e.g. an open search box).