Struct FileAnnotation

pub struct FileAnnotation { /* private fields */ }

Annotation results for a specific file

Implementations

impl FileAnnotation

pub fn line_origins( &self, ) -> impl Iterator<Item = (Result<&LineOrigin, &LineOrigin>, &BStr)>

Returns iterator over (line_origin, line)s.

For each line, Ok(line_origin) returns information about the originator commit of the line. If no originator commit was found within the domain, Err(line_origin) should be set. It points to the commit outside of the domain where the search stopped.

The line includes newline character.

pub fn lines( &self, ) -> impl Iterator<Item = (Result<&CommitId, &CommitId>, &BStr)>

Returns iterator over (commit_id, line)s.

For each line, Ok(commit_id) points to the originator commit of the line. If no originator commit was found within the domain, Err(commit_id) should be set. It points to the commit outside of the domain where the search stopped.

The line includes newline character.

pub fn line_ranges( &self, ) -> impl Iterator<Item = (Result<&CommitId, &CommitId>, Range<usize>)>

Returns iterator over (commit_id, line_range)s.

See Self::lines() for commit_ids.

The line_range is a slice range in the file text. Consecutive ranges having the same commit_id are not compacted.

pub fn compact_line_ranges( &self, ) -> impl Iterator<Item = (Result<&CommitId, &CommitId>, Range<usize>)>

Returns iterator over compacted (commit_id, line_range)s.

Consecutive ranges having the same commit_id are merged into one.

pub fn text(&self) -> &BStr

File content at the starting commit.

Trait Implementations

impl Clone for FileAnnotation

fn clone(&self) -> FileAnnotation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileAnnotation

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

Formats the value using the given formatter.