Struct Outcome

pub struct Outcome {
    pub entries: Vec<BlameEntry>,
    pub blob: Vec<u8>,
    pub statistics: Statistics,
}

The outcome of file().

Fields

entries: Vec<BlameEntry>

One entry in sequential order, to associate a hunk in the blamed file with the source commit (and its lines) that introduced it.

blob: Vec<u8>

A buffer with the file content of the Blamed File, ready for tokenization.

statistics: Statistics

Additional information about the amount of work performed to produce the blame.

Implementations

impl Outcome

pub fn entries_with_lines( &self, ) -> impl Iterator<Item = (BlameEntry, Vec<BString>)> + '_

Return an iterator over each entry in Self::entries, along with its lines, line by line.

Note that Self::blob must be tokenized in exactly the same way as the tokenizer that was used to perform the diffs, which is what this method assures.

Trait Implementations

impl Clone for Outcome

fn clone(&self) -> Outcome

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Outcome

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

Formats the value using the given formatter.

impl Default for Outcome

fn default() -> Outcome

Returns the “default value” for a type.