DiffLine

Struct DiffLine 

Source
pub struct DiffLine {
    pub kind: DiffLineKind,
    pub content: String,
    pub old_line_num: Option<usize>,
    pub new_line_num: Option<usize>,
}
Expand description

Represents a single line in a diff output.

A DiffLine contains the content of the line, its kind (context, added, removed, or hunk header), and the line numbers from both the old and new file versions.

§Fields

  • kind - The type of diff line (context, added, removed, or hunk header)
  • content - The text content of the line
  • old_line_num - Line number in the old version (None for added lines)
  • new_line_num - Line number in the new version (None for removed lines)

Fields§

§kind: DiffLineKind

The type of this diff line.

§content: String

The text content of the line.

§old_line_num: Option<usize>

Line number in the old/original file. None for added lines since they don’t exist in the old version.

§new_line_num: Option<usize>

Line number in the new/modified file. None for removed lines since they don’t exist in the new version.

Implementations§

Source§

impl DiffLine

Source

pub fn added(content: impl Into<String>, new_line_num: usize) -> Self

Creates an added diff line.

Added lines exist only in the new version of the file and are typically displayed with a green background and a ‘+’ prefix.

§Arguments
  • content - The text content of the line
  • new_line_num - Line number in the new version
§Returns

A new DiffLine with DiffLineKind::Added

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

let line = DiffLine::added("new line", 10);
assert!(matches!(line.kind, DiffLineKind::Added));
assert!(line.old_line_num.is_none());
Source§

impl DiffLine

Source

pub fn context( content: impl Into<String>, old_line_num: usize, new_line_num: usize, ) -> Self

Creates a context (unchanged) diff line.

Context lines appear in both the old and new versions of the file and are shown without highlighting to provide surrounding context.

§Arguments
  • content - The text content of the line
  • old_line_num - Line number in the old version
  • new_line_num - Line number in the new version
§Returns

A new DiffLine with DiffLineKind::Context

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

let line = DiffLine::context("unchanged line", 5, 7);
assert!(matches!(line.kind, DiffLineKind::Context));
Source§

impl DiffLine

Source

pub fn hunk_header(content: impl Into<String>) -> Self

Creates a hunk header diff line.

Hunk headers mark the start of a diff section and contain line number information (e.g., @@ -1,4 +1,5 @@ function_name).

§Arguments
  • content - The full hunk header text
§Returns

A new DiffLine with DiffLineKind::HunkHeader

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

let line = DiffLine::hunk_header("@@ -1,4 +1,5 @@ fn main()");
assert!(matches!(line.kind, DiffLineKind::HunkHeader));
Source§

impl DiffLine

Source

pub fn new( kind: DiffLineKind, content: impl Into<String>, old_line_num: Option<usize>, new_line_num: Option<usize>, ) -> Self

Creates a new diff line with all fields specified.

§Arguments
  • kind - The type of diff line
  • content - The text content of the line
  • old_line_num - Line number in the old version (None for added lines)
  • new_line_num - Line number in the new version (None for removed lines)
§Returns

A new DiffLine instance

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

let line = DiffLine::new(
    DiffLineKind::Context,
    "unchanged line",
    Some(10),
    Some(12),
);
Source§

impl DiffLine

Source

pub fn removed(content: impl Into<String>, old_line_num: usize) -> Self

Creates a removed diff line.

Removed lines exist only in the old version of the file and are typically displayed with a red background and a ‘-’ prefix.

§Arguments
  • content - The text content of the line
  • old_line_num - Line number in the old version
§Returns

A new DiffLine with DiffLineKind::Removed

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

let line = DiffLine::removed("deleted line", 5);
assert!(matches!(line.kind, DiffLineKind::Removed));
assert!(line.new_line_num.is_none());
Source§

impl DiffLine

Source

pub fn is_added(&self) -> bool

Returns true if this is an added line.

§Returns

true if the line kind is Added, false otherwise

§Example
use ratatui_toolkit::code_diff::DiffLine;

let line = DiffLine::added("new line", 5);
assert!(line.is_added());
Source§

impl DiffLine

Source

pub fn is_context(&self) -> bool

Returns true if this is a context (unchanged) line.

§Returns

true if the line kind is Context, false otherwise

§Example
use ratatui_toolkit::code_diff::DiffLine;

let line = DiffLine::context("unchanged", 1, 1);
assert!(line.is_context());
Source§

impl DiffLine

Source

pub fn is_hunk_header(&self) -> bool

Returns true if this is a hunk header line.

§Returns

true if the line kind is HunkHeader, false otherwise

§Example
use ratatui_toolkit::code_diff::DiffLine;

let line = DiffLine::hunk_header("@@ -1,4 +1,5 @@");
assert!(line.is_hunk_header());
Source§

impl DiffLine

Source

pub fn is_removed(&self) -> bool

Returns true if this is a removed line.

§Returns

true if the line kind is Removed, false otherwise

§Example
use ratatui_toolkit::code_diff::DiffLine;

let line = DiffLine::removed("deleted line", 5);
assert!(line.is_removed());
Source§

impl DiffLine

Source

pub fn prefix(&self) -> char

Returns the prefix character for this line kind.

  • Context lines: ’ ’ (space)
  • Added lines: ‘+’
  • Removed lines: ‘-’
  • Hunk headers: ‘@’
§Returns

A single character prefix for display

§Example
use ratatui_toolkit::code_diff::DiffLine;

let added = DiffLine::added("new line", 5);
assert_eq!(added.prefix(), '+');

let removed = DiffLine::removed("old line", 5);
assert_eq!(removed.prefix(), '-');

Trait Implementations§

Source§

impl Clone for DiffLine

Source§

fn clone(&self) -> DiffLine

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 DiffLine

Source§

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

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

impl PartialEq for DiffLine

Source§

fn eq(&self, other: &DiffLine) -> 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 DiffLine

Source§

impl StructuralPartialEq for DiffLine

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