DiffHunk

Struct DiffHunk 

Source
pub struct DiffHunk {
    pub old_start: usize,
    pub old_count: usize,
    pub new_start: usize,
    pub new_count: usize,
    pub context: Option<String>,
    pub lines: Vec<DiffLine>,
}
Expand description

Represents a single hunk (section) in a diff.

A hunk contains the line range information and a collection of lines that make up this section of the diff. The header information (old_start, old_count, new_start, new_count) corresponds to the unified diff format: @@ -old_start,old_count +new_start,new_count @@ context

§Fields

  • old_start - Starting line number in the old file
  • old_count - Number of lines from the old file in this hunk
  • new_start - Starting line number in the new file
  • new_count - Number of lines from the new file in this hunk
  • context - Optional context text (e.g., function name) shown in the header
  • lines - The actual diff lines in this hunk

Fields§

§old_start: usize

Starting line number in the old/original file.

§old_count: usize

Number of lines from the old file included in this hunk.

§new_start: usize

Starting line number in the new/modified file.

§new_count: usize

Number of lines from the new file included in this hunk.

§context: Option<String>

Optional context text from the hunk header (e.g., function name).

§lines: Vec<DiffLine>

The lines in this hunk, including context, added, and removed lines.

Implementations§

Source§

impl DiffHunk

Source

pub fn from_header(header: &str) -> Option<Self>

Creates a new diff hunk by parsing a unified diff header line.

Parses headers in the format: @@ -old_start,old_count +new_start,new_count @@ context

§Arguments
  • header - The hunk header line to parse
§Returns

Some(DiffHunk) if parsing succeeds, None otherwise

§Example
use ratatui_toolkit::code_diff::DiffHunk;

let hunk = DiffHunk::from_header("@@ -1,4 +1,5 @@ fn main()").unwrap();
assert_eq!(hunk.old_start, 1);
assert_eq!(hunk.old_count, 4);
assert_eq!(hunk.new_start, 1);
assert_eq!(hunk.new_count, 5);
assert_eq!(hunk.context.as_deref(), Some("fn main()"));
Source§

impl DiffHunk

Source

pub fn new( old_start: usize, old_count: usize, new_start: usize, new_count: usize, ) -> Self

Creates a new diff hunk with the specified line ranges.

§Arguments
  • old_start - Starting line number in the old file
  • old_count - Number of lines from the old file
  • new_start - Starting line number in the new file
  • new_count - Number of lines from the new file
§Returns

A new DiffHunk with empty lines and no context

§Example
use ratatui_toolkit::code_diff::DiffHunk;

let hunk = DiffHunk::new(1, 4, 1, 5);
assert_eq!(hunk.old_start, 1);
assert_eq!(hunk.old_count, 4);
Source§

impl DiffHunk

Source

pub fn add_line(&mut self, line: DiffLine)

Adds a diff line to this hunk.

§Arguments
  • line - The diff line to add
§Example
use ratatui_toolkit::code_diff::{DiffHunk, DiffLine};

let mut hunk = DiffHunk::new(1, 2, 1, 3);
hunk.add_line(DiffLine::context("unchanged", 1, 1));
hunk.add_line(DiffLine::added("new line", 2));
Source§

impl DiffHunk

Source

pub fn added_count(&self) -> usize

Returns the number of added lines in this hunk.

§Returns

The count of lines with DiffLineKind::Added

§Example
use ratatui_toolkit::code_diff::{DiffHunk, DiffLine};

let mut hunk = DiffHunk::new(1, 2, 1, 3);
hunk.add_line(DiffLine::added("new line 1", 1));
hunk.add_line(DiffLine::added("new line 2", 2));
assert_eq!(hunk.added_count(), 2);
Source§

impl DiffHunk

Source

pub fn header_text(&self) -> String

Returns the formatted header text for this hunk.

Generates a unified diff style header like @@ -1,4 +1,5 @@ context.

§Returns

The formatted header string

§Example
use ratatui_toolkit::code_diff::DiffHunk;

let mut hunk = DiffHunk::new(1, 4, 1, 5);
assert_eq!(hunk.header_text(), "@@ -1,4 +1,5 @@");
Source§

impl DiffHunk

Source

pub fn removed_count(&self) -> usize

Returns the number of removed lines in this hunk.

§Returns

The count of lines with DiffLineKind::Removed

§Example
use ratatui_toolkit::code_diff::{DiffHunk, DiffLine};

let mut hunk = DiffHunk::new(1, 3, 1, 2);
hunk.add_line(DiffLine::removed("old line 1", 1));
hunk.add_line(DiffLine::removed("old line 2", 2));
assert_eq!(hunk.removed_count(), 2);

Trait Implementations§

Source§

impl Clone for DiffHunk

Source§

fn clone(&self) -> DiffHunk

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DiffHunk

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for DiffHunk

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Eq for DiffHunk

Source§

impl StructuralPartialEq for DiffHunk

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more