Skip to main content

BlameSession

Struct BlameSession 

Source
pub struct BlameSession { /* private fields */ }
Available on crate feature vcs-git only.
Expand description

A PerFunctionBlame bound to one thread, holding the state a blame would otherwise rebuild per file.

Obtained from PerFunctionBlame::session. Not Sync — it holds a gix::Repository — so a worker pool wants one session per thread. The engine it was opened from is kept alive by the session and readable through engine, so a caller memoising sessions can confirm a cached one belongs to the engine at hand.

Implementations§

Source§

impl BlameSession

Source

pub fn engine(&self) -> &Arc<PerFunctionBlame>

The engine this session was opened from.

Compare with Arc::ptr_eq to confirm a memoised session belongs to the engine a caller is about to blame with.

Source

pub fn commits_resolved(&self) -> usize

How many distinct commits this session has resolved so far — the size of the memo that makes a session worth holding.

Grows only when a blame meets a commit the session has not seen, so it is also how a caller sizes the session’s memory (see SessionState::commits) or confirms the memo is doing its job.

Source

pub fn per_function( &mut self, absolute: &Path, spans: &[LineSpan], ) -> Result<Vec<Stats>, Error>

Blame the file at absolute once and return one Stats per entry in spans, in the same order — the session-backed form of PerFunctionBlame::per_function, with identical semantics.

§Errors

See PerFunctionBlame::per_function.

Trait Implementations§

Source§

impl Debug for BlameSession

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.