Struct FileAnnotator

pub struct FileAnnotator { /* private fields */ }

Annotation process for a specific file.

Implementations

impl FileAnnotator

pub fn from_commit( starting_commit: &Commit, file_path: &RepoPath, ) -> BackendResult<Self>

Initializes annotator for a specific file in the starting_commit.

If the file is not found, the result would be empty.

pub fn with_file_content( starting_commit_id: &CommitId, file_path: &RepoPath, starting_text: impl Into<Vec<u8>>, ) -> Self

Initializes annotator for a specific file path starting with the given content.

The file content at the starting_commit is set to starting_text. This is typically one of the file contents in the conflict or merged-parent tree.

pub fn compute( &mut self, repo: &dyn Repo, domain: &Rc<ResolvedRevsetExpression>, ) -> Result<(), RevsetEvaluationError>

Computes line-by-line annotation within the domain.

The domain expression narrows the range of ancestors to search. It will be intersected as domain & ::pending_commits & files(file_path). The pending_commits is assumed to be included in the domain.

pub fn pending_commits(&self) -> impl Iterator<Item = &CommitId>

Remaining commit ids to visit from.

pub fn to_annotation(&self) -> FileAnnotation

Returns the current state as line-oriented annotation.

Trait Implementations

impl Clone for FileAnnotator

fn clone(&self) -> FileAnnotator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileAnnotator

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

Formats the value using the given formatter.