Skip to main content

DefaultHunkFinder

Struct DefaultHunkFinder 

Source
pub struct DefaultHunkFinder<'a> { /* private fields */ }
Expand description

The default, built-in strategy for finding hunk locations.

This implementation uses a hierarchical approach:

  1. Exact match.
  2. Exact match ignoring trailing whitespace.
  3. Flexible fuzzy match using a similarity algorithm.

It uses line number hints from the patch to resolve ambiguities. While you can use this struct directly, it’s typically used internally by functions like find_hunk_location_in_lines().

§Example

let original_lines = vec!["line 1", "line two", "line 3"];
let diff = r#"
```diff
--- a/file.txt
+++ b/file.txt
@@ -1,3 +1,3 @@
 line 1
-line two
+line 2
 line 3
```
"#;
let hunk = parse_single_patch(diff)?.hunks.remove(0);

let options = ApplyOptions::exact();
let finder = DefaultHunkFinder::new(&options);

// Use the finder to locate the hunk.
let (location, match_type) = finder.find_location(&hunk, &original_lines)?;

assert_eq!(location, HunkLocation { start_index: 0, length: 3 });
assert!(matches!(match_type, MatchType::Exact));

Implementations§

Source§

impl<'a> DefaultHunkFinder<'a>

Source

pub fn new(options: &'a ApplyOptions) -> Self

Creates a new finder with the given options.

This is the standard way to instantiate the DefaultHunkFinder. The provided ApplyOptions will control the behavior of the finder, particularly the fuzz_factor which determines the threshold for fuzzy matching.

§Example
// Create a finder that requires a high similarity for fuzzy matches.
let options = ApplyOptions::new().with_fuzz_factor(0.9);
let finder = DefaultHunkFinder::new(&options);

Trait Implementations§

Source§

impl<'a> Debug for DefaultHunkFinder<'a>

Source§

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

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

impl<'a> HunkFinder for DefaultHunkFinder<'a>

Source§

fn find_location<T: AsRef<str> + Sync>( &self, hunk: &Hunk, target_lines: &[T], ) -> Result<(HunkLocation, MatchType), HunkApplyError>

Finds the location to apply a hunk to a slice of lines. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for DefaultHunkFinder<'a>

§

impl<'a> RefUnwindSafe for DefaultHunkFinder<'a>

§

impl<'a> Send for DefaultHunkFinder<'a>

§

impl<'a> Sync for DefaultHunkFinder<'a>

§

impl<'a> Unpin for DefaultHunkFinder<'a>

§

impl<'a> UnsafeUnpin for DefaultHunkFinder<'a>

§

impl<'a> UnwindSafe for DefaultHunkFinder<'a>

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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.