Struct DiffViewerState 

pub struct DiffViewerState { /* private fields */ }

State for a DiffViewer component.

Contains the diff hunks, display mode, scroll position, and UI options.

Implementations

impl DiffViewerState

pub fn new() -> Self

Creates a new empty diff viewer state.

Example

use envision::component::DiffViewerState;

let state = DiffViewerState::new();
assert!(state.hunks().is_empty());
assert_eq!(state.current_hunk(), 0);

pub fn from_diff(diff_text: &str) -> Self

Creates a diff viewer from a unified diff string.

Example

use envision::component::DiffViewerState;

let diff = "\
--- a/file.rs
+++ b/file.rs
@@ -1,3 +1,3 @@
 fn main() {
-    old();
+    new();
 }
";
let state = DiffViewerState::from_diff(diff);
assert_eq!(state.hunk_count(), 1);

pub fn from_texts(old: &str, new: &str) -> Self

Creates a diff viewer by computing a diff from two text strings.

Example

use envision::component::DiffViewerState;

let state = DiffViewerState::from_texts("old line", "new line");
assert_eq!(state.hunk_count(), 1);

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

Sets the display mode (builder pattern).

Example

use envision::component::{DiffViewerState, DiffMode};

let state = DiffViewerState::new().with_mode(DiffMode::SideBySide);

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

Sets the number of context lines for compute_diff (builder pattern).

Example

use envision::component::DiffViewerState;

let state = DiffViewerState::new().with_context_lines(5);

pub fn with_show_line_numbers(self, show: bool) -> Self

Sets whether to show line numbers (builder pattern).

Example

use envision::component::DiffViewerState;

let state = DiffViewerState::new().with_show_line_numbers(false);

pub fn with_title(self, title: impl Into<String>) -> Self

Sets the title (builder pattern).

Example

use envision::component::DiffViewerState;

let state = DiffViewerState::new().with_title("My Diff");

pub fn with_old_label(self, label: impl Into<String>) -> Self

Sets the label for the old file (builder pattern).

Example

use envision::component::DiffViewerState;

let state = DiffViewerState::new().with_old_label("original.rs");

pub fn with_new_label(self, label: impl Into<String>) -> Self

Sets the label for the new file (builder pattern).

Example

use envision::component::DiffViewerState;

let state = DiffViewerState::new().with_new_label("modified.rs");

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

Returns the title, if set.

Example

use envision::component::DiffViewerState;

let state = DiffViewerState::new().with_title("My Diff");
assert_eq!(state.title(), Some("My Diff"));

let state2 = DiffViewerState::new();
assert_eq!(state2.title(), None);

pub fn set_title(&mut self, title: impl Into<String>)

Sets the title.

Example

use envision::component::DiffViewerState;

let mut state = DiffViewerState::new();
state.set_title("Code Review");
assert_eq!(state.title(), Some("Code Review"));

pub fn hunks(&self) -> &[DiffHunk]

Returns a reference to the diff hunks.

pub fn hunk_count(&self) -> usize

Returns the number of hunks in the diff.

pub fn current_hunk(&self) -> usize

Returns the current hunk index.

pub fn total_lines(&self) -> usize

Returns the total number of displayable lines across all hunks.

Example

use envision::component::DiffViewerState;

let state = DiffViewerState::from_texts("old line", "new line");
assert!(state.total_lines() > 0);

pub fn added_count(&self) -> usize

Returns the count of added lines across all hunks.

Example

use envision::component::DiffViewerState;

let state = DiffViewerState::from_texts("old", "new\nextra");
assert!(state.added_count() >= 1);

pub fn removed_count(&self) -> usize

Returns the count of removed lines across all hunks.

Example

use envision::component::DiffViewerState;

let state = DiffViewerState::from_texts("old\nextra", "new");
assert!(state.removed_count() >= 1);

pub fn changed_count(&self) -> usize

Returns the count of changed lines (added + removed).

Example

use envision::component::DiffViewerState;

let state = DiffViewerState::from_texts("old line", "new line");
assert_eq!(state.changed_count(), state.added_count() + state.removed_count());

pub fn show_line_numbers(&self) -> bool

Returns whether line numbers are shown.

Example

use envision::component::DiffViewerState;

let state = DiffViewerState::new();
assert!(state.show_line_numbers());

pub fn set_show_line_numbers(&mut self, show: bool)

Sets whether line numbers are shown.

Example

use envision::component::DiffViewerState;

let mut state = DiffViewerState::new();
state.set_show_line_numbers(false);
assert!(!state.show_line_numbers());

pub fn context_lines(&self) -> usize

Returns the number of context lines.

Example

use envision::component::DiffViewerState;

let state = DiffViewerState::new();
assert_eq!(state.context_lines(), 3);

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

Returns the old label, if set.

Example

use envision::component::DiffViewerState;

let state = DiffViewerState::new().with_old_label("original.rs");
assert_eq!(state.old_label(), Some("original.rs"));

pub fn set_old_label(&mut self, label: impl Into<String>)

Sets the old label.

Example

use envision::component::DiffViewerState;

let mut state = DiffViewerState::new();
state.set_old_label("original.rs");
assert_eq!(state.old_label(), Some("original.rs"));

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

Returns the new label, if set.

Example

use envision::component::DiffViewerState;

let state = DiffViewerState::new().with_new_label("modified.rs");
assert_eq!(state.new_label(), Some("modified.rs"));

pub fn set_new_label(&mut self, label: impl Into<String>)

Sets the new label.

Example

use envision::component::DiffViewerState;

let mut state = DiffViewerState::new();
state.set_new_label("modified.rs");
assert_eq!(state.new_label(), Some("modified.rs"));

pub fn mode(&self) -> &DiffMode

Returns the display mode.

Example

use envision::component::{DiffViewerState, DiffMode};

let state = DiffViewerState::new();
assert_eq!(state.mode(), &DiffMode::Unified);

let state = DiffViewerState::new().with_mode(DiffMode::SideBySide);
assert_eq!(state.mode(), &DiffMode::SideBySide);

pub fn scroll_offset(&self) -> usize

Returns the current scroll offset.

pub fn update(&mut self, msg: DiffViewerMessage) -> Option<DiffViewerOutput>

Updates the state with a message, returning any output.

Example

use envision::component::{DiffViewerState, DiffViewerMessage};

let old = "line1\nline2\nline3";
let new = "line1\nchanged\nline3";
let mut state = DiffViewerState::from_texts(old, new);
let _output = state.update(DiffViewerMessage::ScrollDown);

Trait Implementations

impl Clone for DiffViewerState

fn clone(&self) -> DiffViewerState

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DiffViewerState

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

Formats the value using the given formatter.

impl Default for DiffViewerState

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DiffViewerState

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for DiffViewerState

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for DiffViewerState

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.