Struct BlameEntry

pub struct BlameEntry {
    pub start_in_blamed_file: u32,
    pub start_in_source_file: u32,
    pub len: NonZeroU32,
    pub commit_id: ObjectId,
    pub source_file_name: Option<BString>,
}

A mapping of a section of the Blamed File to the section in a Source File that introduced it.

Both ranges are of the same size, but may use different starting points. Naturally, they have the same content, which is the reason they are in what is returned by file().

Fields

start_in_blamed_file: u32

The index of the token in the Blamed File (typically lines) where this entry begins.

start_in_source_file: u32

The index of the token in the Source File (typically lines) where this entry begins.

This is possibly offset compared to start_in_blamed_file.

len: NonZeroU32

The amount of lines the hunk is spanning.

commit_id: ObjectId

The commit that introduced the section into the Source File.

source_file_name: Option<BString>

The Source File’s name, in case it differs from Blamed File’s name. This happens when the file was renamed.

Implementations

impl BlameEntry

pub fn new( range_in_blamed_file: Range<u32>, range_in_source_file: Range<u32>, commit_id: ObjectId, source_file_name: Option<BString>, ) -> Self

Create a new instance.

impl BlameEntry

pub fn range_in_blamed_file(&self) -> Range<usize>

Return the range of tokens this entry spans in the Blamed File.

pub fn range_in_source_file(&self) -> Range<usize>

Return the range of tokens this entry spans in the Source File.

Trait Implementations

impl Clone for BlameEntry

fn clone(&self) -> BlameEntry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BlameEntry

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

Formats the value using the given formatter.

impl PartialEq for BlameEntry

fn eq(&self, other: &BlameEntry) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for BlameEntry