Struct Pickaxe 

pub struct Pickaxe { /* private fields */ }

Compiled pickaxe filter for crate::rev_list::rev_list.

Implementations

impl Pickaxe

pub fn occurrences(needle: impl Into<String>) -> Self

-S / occurrence-count pickaxe (literal string unless Self::pickaxe_regex).

pub fn line_grep(pattern: &str, ignore_case: bool) -> Result<Self, PickaxeError>

-G / line-level regex pickaxe (Git REG_EXTENDED | REG_NEWLINE).

Errors

Returns PickaxeError::InvalidPattern when the pattern does not compile.

pub fn ignore_case(self, on: bool) -> Self

Case-insensitive matching (Git -i / --regexp-ignore-case).

pub fn pickaxe_regex(self, on: bool) -> Self

Treat -S needle as an ERE (--pickaxe-regex; only valid with occurrence mode).

pub fn build(self) -> Result<Self, PickaxeError>

Finalize a pickaxe built with Self::occurrences (compiles ERE when requested).

Errors

Returns PickaxeError::InvalidPattern when --pickaxe-regex is set and the needle does not compile as ERE.

pub fn is_active(&self) -> bool

Whether this filter requires per-commit tree diffs.

pub fn into_shared(self) -> Arc<Self>

Shared handle for crate::rev_list::RevListOptions.

pub fn matches_commit( &self, repo: &Repository, commit_oid: ObjectId, paths: &[String], renames: RenameDetection, config: &ConfigSet, ) -> Result<bool>

Returns true when commit would be kept by git log with this pickaxe vs its first parent.

Matches Git’s order of work: the tree diff is limited to paths first, then deleted and added paths are paired as renames per renames, and only then is each file pair tested. A rename whose old and new file hold the same number of matches (-S), or whose diff changes no matching line (-G), is therefore not a change. A file moved into the pathspec from outside it is an addition, since its old path was never diffed.

Merge commits are skipped (Git default without combined merge diffs). Non-merge commits compare to the first parent only. Binary files are skipped for -G; -S searches binary blobs.

Parameters

• paths — repository-relative pathspecs limiting the diff; empty means the whole tree.
• renames — rename pairing; callers following Git use renames_from_config (diff.renames).
• config — supplies diff.renameLimit and rename-scoring thread settings.

Errors

Propagates object read and diff errors.

Trait Implementations

impl Clone for Pickaxe

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Pickaxe

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

Formats the value using the given formatter.