Struct Snapshot

source

pub struct Snapshot { /* private fields */ }

Expand description

A data-structure to efficiently store a list of entries for optimal, case-insensitive lookup by email and optionally name to find mappings to new names and/or emails.

The memory layout is efficient, even though lots of small allocations are performed to store strings of emails and names.

Implementations§

source §

impl Snapshot

source

pub fn from_bytes(buf: &[u8]) -> Self

Create a new snapshot from the given bytes buffer, ignoring all parse errors that may occur on a line-by-line basis.

This is similar to what git does.

source

pub fn new<'a>(entries: impl IntoIterator<Item = Entry<'a>>) -> Self

Create a new instance from entries.

These can be obtained using crate::parse().

source

pub fn merge<'a>( &mut self, entries: impl IntoIterator<Item = Entry<'a>>, ) -> &mut Self

Merge the given entries into this instance, possibly overwriting existing mappings with new ones should they collide.

source

pub fn iter(&self) -> impl Iterator<Item = Entry<'_>>

Transform our acceleration structure into an iterator of entries.

Note that the order is different from how they were obtained initially, and are explicitly ordered by (old_email, old_name).

source

pub fn entries(&self) -> Vec<Entry<'_>>

Transform our acceleration structure into a list of entries.

Note that the order is different from how they were obtained initially, and are explicitly ordered by (old_email, old_name).

source

pub fn try_resolve_ref( &self, signature: SignatureRef<'_>, ) -> Option<ResolvedSignature<'_>>

Try to resolve signature by its contained email and name and provide resolved/mapped names as reference. Return None if no such mapping was found.

Note that opposed to what git seems to do, we also normalize the case of email addresses to match the one given in the mailmap. That is, if Alex@example.com is the current email, it will be matched and replaced with alex@example.com. This leads to better mapping results and saves entries in the mailmap.

This is the fastest possible lookup as there is no allocation.

source

pub fn try_resolve(&self, signature: SignatureRef<'_>) -> Option<Signature>

Try to resolve signature by its contained email and name and provide resolved/mapped names as owned signature, with the mapped name and/or email replaced accordingly.

Return None if no such mapping was found.

source

pub fn resolve(&self, signature: SignatureRef<'_>) -> Signature

Like try_resolve(), but always returns an owned signature, which might be a copy of signature if no mapping was found.

Note that this method will always allocate.

source

pub fn resolve_cow<'a>(&self, signature: SignatureRef<'a>) -> Signature<'a>

Like try_resolve(), but always returns a special copy-on-write signature, which contains changed names or emails as Cow::Owned, or Cow::Borrowed if no mapping was found.