Struct Engine 

pub struct Engine { /* private fields */ }

Implementations

impl Engine

pub fn search_read(&mut self, query: String) -> Result<SearchRead>

Captures diff text and the current reading origin. It does not start a worker. The caller owns cancellation/join and must reject superseded query replies.

pub fn show_search_match(&mut self, found: &SearchMatch) -> Result<()>

Selects a validated match without accepting another query’s late reply for the caller.

pub fn clear_search_match(&mut self)

impl Engine

pub fn selection(&self) -> Option<SourceRange>

The selected original-side range. It can include unavailable patch-only gaps. source_read rejects those gaps when streaming, before visible publication.

pub fn selection_extending(&self) -> bool

impl Engine

pub fn open( input: Input, options: Options, wake: SyncSender<()>, ) -> Result<Self>

pub fn review_id(&self) -> ReviewId

pub fn options(&self) -> Options

pub fn file(&self, index: usize) -> Option<&FileMetadata>

pub fn source_read(&mut self, range: SourceRange) -> Result<SourceRead>

Prepares an owned source job without reading source bodies on the input thread. Streaming rejects missing lines unless checked full source covers the range.

pub fn status(&self) -> Status<'_>

pub fn selected_source(&self) -> Result<Option<SourceLocation>>

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

Clear the host wake token before calling this. Each drain is bounded so input can run: the input worker queues a bounded number of files, and this takes all of them at once.

pub fn needs_draw(&self) -> bool

pub fn draw(&mut self, frame: &mut Frame<'_>, area: Rect) -> Result<()>

Draw only into the intersection with the frame. The supplied pane controls reflow.

pub fn draw_with_controls( &mut self, frame: &mut Frame<'_>, area: Rect, controls: Option<&ReadingControls<'_>>, ) -> Result<()>

pub fn after_draw(&mut self)

Call after a successful host terminal draw, before handling more events. Visible work starts after the text frame has been written, not while it is being composed.

pub fn handle_event( &mut self, event: Event, focused: bool, ) -> Result<InputEffect>

The host routes keyboard focus; mouse coordinates remain absolute terminal cells.

pub fn execute(&mut self, command: Command) -> Result<InputEffect>

pub fn replace(&mut self, input: Input) -> Result<()>

Close the previous review before creating fresh channels, identity and workers.

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

Joins engine workers and releases its view/source ownership. Caller-owned source jobs are revoked but must be joined and dropped by their owner. Individual parser calls are not interruptible.

Trait Implementations

impl Drop for Engine

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.