Struct DiffReviewState 

pub struct DiffReviewState { /* private fields */ }

Persistent state for crate::DiffReviewWidget.

Implementations

impl DiffReviewState

pub fn command_for_key(&self, key: KeyEvent) -> Option<DiffReviewCommand>

pub fn command_context(&self) -> CommandContext

pub fn set_capabilities(&mut self, capabilities: ReviewCapabilities)

pub fn command_enabled(&self, command: &DiffReviewCommand) -> bool

pub fn handle_command( &mut self, command: impl Into<DiffReviewCommand>, ) -> InputOutcome<DiffReviewEvent>

impl DiffReviewState

pub fn interaction_phase(&self) -> InteractionPhase

pub fn handle_input( &mut self, input: ReviewInput, ) -> InputOutcome<DiffReviewEvent>

impl DiffReviewState

pub fn new(document: Arc<DiffDocument>) -> Self

Creates ready state from an immutable document snapshot.

pub fn with_theme(document: Arc<DiffDocument>, theme: ReviewTheme) -> Self

Creates ready state with a shared neutral theme.

pub fn loading() -> Self

Creates loading state with an empty placeholder document.

pub const fn session(&self) -> &ReviewSession

pub const fn session_mut(&mut self) -> &mut ReviewSession

pub const fn scope(&self) -> DiffScope

pub fn set_scope(&mut self, scope: DiffScope)

pub const fn document(&self) -> &Arc<DiffDocument>

Returns the current immutable snapshot.

pub const fn review(&self) -> &Review

Returns the structured review.

pub const fn review_mut(&mut self) -> &mut Review

Returns mutable review access for host-driven operations.

pub const fn presentation(&self) -> &DiffPresentation

pub const fn status(&self) -> &DiffReviewStatus

Returns the current load status.

pub const fn focus(&self) -> FocusPane

Returns the focused pane.

pub fn selected_file(&self) -> Option<usize>

Returns the selected file index, when the document has files.

pub fn selected_row(&self) -> Option<usize>

Returns the selected presentation-row index, when rows exist.

pub const fn selected_side(&self) -> DiffSide

pub const fn theme(&self) -> &ReviewTheme

Returns the active renderer-neutral theme.

pub const fn highlight_stats(&self) -> HighlightStats

Returns syntax cache and work counters.

pub const fn scroll_offset(&self) -> usize

Returns the first visible rendered-row index in the selected file.

pub const fn is_dirty(&self) -> bool

Returns whether anything since the last frame changed what a redraw would show.

Hosts may skip drawing crate::DiffReviewWidget while this is false, which keeps pointer motion in a terminal reporting all mouse movement from costing a frame each. Rendering the widget clears it.

pub const fn mark_dirty(&mut self)

Marks the state as needing a redraw, for changes the widget cannot observe on its own, such as a terminal resize.

pub const fn view_mode(&self) -> ViewMode

Returns the requested view mode.

pub const fn layout(&self) -> Layout

pub const fn cursor_position(&self) -> Option<Position>

Returns the terminal cursor position for an active comment draft.

Hosts may pass this to Frame::set_cursor_position after rendering.

pub fn set_document(&mut self, document: Arc<DiffDocument>)

Replaces the complete document while retaining and reconciling review comments.

pub fn set_loading(&mut self)

Marks the state as waiting for a host snapshot.

pub fn set_error(&mut self, message: impl Into<String>)

Shows a host-provided loading error.

pub fn set_repository_pending(&mut self)

Marks a repository mutation as in flight while retaining the current snapshot.

pub fn clear_repository_pending(&mut self)

Clears a pending repository mutation without replacing the snapshot.

pub fn set_repository_error(&mut self, message: impl Into<String>)

Shows a repository mutation error while retaining the current snapshot.

pub fn set_background_error(&mut self, message: Option<String>)

Reconciles background refresh health independently of command completion.

pub fn repository_pending(&self) -> bool

Whether a host command is still in flight.

pub fn repository_error(&self) -> Option<&str>

The command error, or otherwise the current background refresh failure.

pub fn set_theme(&mut self, theme: ReviewTheme)

pub const fn options(&self) -> &ReviewOptions

pub fn keybindings(&self) -> &[KeyBinding<DiffReviewCommand>]

pub fn set_keybindings( &mut self, bindings: impl Into<Vec<KeyBinding<DiffReviewCommand>>>, )

pub fn set_options(&mut self, options: ReviewOptions)

pub fn theme_choices(&self) -> &[ThemeChoice]

pub fn set_theme_choices(&mut self, themes: impl Into<Arc<[ThemeChoice]>>)

pub fn reveal_selected_gap(&mut self, amount: RevealAmount) -> bool

pub fn toggle_full_file(&mut self) -> bool

pub fn set_view_mode(&mut self, mode: ViewMode)

Selects automatic, unified, or split presentation.

pub fn clear_review(&mut self)

Clears all queued comments and any active draft.

Trait Implementations

impl Debug for DiffReviewState

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

Formats the value using the given formatter.