Struct DiffState 

pub struct DiffState { /* private fields */ }

Retained focus, viewport, context expansion and selection for a super::Diff showing one or more files of a patch.

Create once in the owning view. Mutations notify observers; the application owns the patch and chooses when to install new files. Syntax and inline emphasis are prepared on a background thread and appear once ready.

Implementations

impl DiffState

pub fn new( files: impl IntoIterator<Item = DiffFile>, cx: &mut Context<'_, Self>, ) -> Self

Creates a unified viewer with three unchanged lines around each change.

pub fn with_mode(self, mode: DiffMode) -> Self

Sets the initial display mode. Default is DiffMode::Unified.

pub fn with_context_lines(self, lines: Option<usize>) -> Self

Sets the initial unchanged context around each change. Default is Some(3); None shows every supplied patch line.

pub fn with_expansion_lines(self, lines: usize) -> Self

Sets how many lines an up or down disclosure reveals. Default is 20.

pub fn with_min_collapsed_lines(self, lines: usize) -> Self

Sets the shortest unchanged range that collapses; shorter ranges stay visible. Default is 2.

pub fn with_inline_unit(self, unit: Option<DiffInlineUnit>) -> Self

Sets the unit inline changes between paired lines are emphasized in, or None to emphasize whole lines only. Default is DiffInlineUnit::Word.

pub fn with_inline_max_line_length(self, length: usize) -> Self

Sets the longest line, in bytes, compared for inline changes. Default is 1,000.

pub fn with_syntax_max_line_length(self, length: usize) -> Self

Sets the longest line, in bytes, given syntax emphasis. Default is 1,000.

pub fn with_syntax_highlighter<F>(self, highlighter: F) -> Self

where F: Fn(&str, &str) -> Vec<(Range<usize>, HighlightStyle)> + Send + Sync + 'static,

Highlights syntax with the application’s highlighter instead of GPUI Kit’s. Given a file’s language and the source text of one side of one hunk, it returns byte ranges into that text with their styles; a range that splits a character is ignored.

It runs on the background executor, once for each side of each hunk, so an unterminated comment in one hunk cannot color the next. Styles are kept as returned rather than resolved against the theme when a line paints; set a new highlighter when its colors change.

pub fn set_syntax_highlighter<F>( &mut self, highlighter: F, cx: &mut Context<'_, Self>, )

where F: Fn(&str, &str) -> Vec<(Range<usize>, HighlightStyle)> + Send + Sync + 'static,

Replaces the application’s highlighter, preparing syntax again without resetting selection or scrolling. See Self::with_syntax_highlighter.

pub fn clear_syntax_highlighter(&mut self, cx: &mut Context<'_, Self>)

Returns to GPUI Kit’s highlighter, preparing syntax again without resetting selection or scrolling.

pub fn set_expansion_lines(&mut self, lines: usize, cx: &mut Context<'_, Self>)

Changes the number of lines each disclosure reveals, preserving selection and scrolling.

pub fn set_min_collapsed_lines( &mut self, lines: usize, cx: &mut Context<'_, Self>, )

Changes the shortest unchanged range that collapses, preserving selection and scrolling.

pub fn set_inline_unit( &mut self, unit: Option<DiffInlineUnit>, cx: &mut Context<'_, Self>, )

Changes the inline comparison unit without resetting selection or scrolling.

pub fn set_inline_max_line_length( &mut self, length: usize, cx: &mut Context<'_, Self>, )

Changes the inline comparison line limit in bytes without resetting selection or scrolling.

pub fn set_syntax_max_line_length( &mut self, length: usize, cx: &mut Context<'_, Self>, )

Changes the syntax emphasis line limit in bytes without resetting selection or scrolling.

pub fn files(&self) -> &[DiffFile]

The files in patch order.

pub fn mode(&self) -> DiffMode

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

pub fn expansion_lines(&self) -> usize

pub fn min_collapsed_lines(&self) -> usize

pub fn inline_unit(&self) -> Option<DiffInlineUnit>

pub fn inline_max_line_length(&self) -> usize

pub fn syntax_max_line_length(&self) -> usize

pub fn selected_lines(&self) -> Option<DiffLineRange>

pub fn is_file_collapsed(&self, path: &str) -> bool

Whether the file at path shows only its header.

pub fn set_files( &mut self, files: impl IntoIterator<Item = DiffFile>, cx: &mut Context<'_, Self>, )

Replaces the files and resets expansion, selection and viewport. Collapsed files stay collapsed when their path is still present.

pub fn set_mode(&mut self, mode: DiffMode, cx: &mut Context<'_, Self>)

Changes the display mode while preserving source-line selection and a nearby source row.

pub fn set_context_lines( &mut self, lines: Option<usize>, cx: &mut Context<'_, Self>, )

Sets surrounding context. None shows every supplied patch line.

pub fn expand_unchanged(&mut self, cx: &mut Context<'_, Self>)

Reveals all unchanged source while preserving the configured context count.

pub fn collapse_unchanged(&mut self, cx: &mut Context<'_, Self>)

Restores the configured context disclosures.

pub fn set_file_collapsed( &mut self, path: &str, collapsed: bool, cx: &mut Context<'_, Self>, )

Collapses the file at path to its header, or expands it, without emitting a user event.

pub fn conflict_resolution( &self, path: &str, ix: usize, ) -> Option<DiffConflictResolution>

The resolution of conflict ix in the file at path, if any. Use DiffFile::conflicts to enumerate valid indices; None means unresolved, or that the file or index does not exist.

pub fn resolve_conflict( &mut self, path: &str, ix: usize, resolution: Option<DiffConflictResolution>, cx: &mut Context<'_, Self>, )

Resolves conflict ix (an index in DiffFile::conflicts) in the file at path, or clears its resolution with None, without emitting a user event.

pub fn resolved_text(&self, path: &str) -> Option<String>

The working file with every conflict replaced by its resolution, or None while a conflict is unresolved or path names no conflicted file.

pub fn set_selected_lines( &mut self, range: Option<DiffLineRange>, cx: &mut Context<'_, Self>, )

Synchronizes source-line selection without emitting a user event. Clips to supplied patch lines; a range containing none clears selection.

pub fn selected_text(&self, cx: &App) -> String

Returns selected source without gutters, diff markers or annotation content.

pub fn scroll_to_line( &mut self, position: DiffLinePosition, cx: &mut Context<'_, Self>, )

Reveals and scrolls to a source line, expanding its file and hidden context if needed.

pub fn scroll_to_file(&mut self, path: &str, cx: &mut Context<'_, Self>)

Scrolls to the header of the file at path, a DiffFile::path.

pub fn next_change(&mut self, cx: &mut Context<'_, Self>)

Moves to the next changed group after the current viewport, across files, wrapping to the first once the list is scrolled to its end.

pub fn previous_change(&mut self, cx: &mut Context<'_, Self>)

Moves to the previous changed group before the current viewport, across files.

Trait Implementations

impl EventEmitter<DiffEvent> for DiffState

impl Focusable for DiffState

fn focus_handle(&self, _: &App) -> FocusHandle

Returns the focus handle associated with this view.