Skip to main content

AliasIndex

Struct AliasIndex 

Source
pub struct AliasIndex { /* private fields */ }
Expand description

One project-wide index from every accepted alias to a canonical issue reference.

The index is built once per read operation. Numbers, filenames, and titles are aliases; ids are identity. Duplicate ids are recorded and make the index unusable for graph work rather than allowing one file to shadow another.

Implementations§

Source§

impl AliasIndex

Source

pub fn len(&self) -> usize

How many canonical issues the index holds.

Source

pub fn is_empty(&self) -> bool

Whether the index contains no issue records.

Source

pub fn scanned_nodes(&self) -> usize

How many issue records the single index-building pass examined.

Source

pub fn build<N: IdentityNode>(nodes: &[N]) -> Self

Build the complete alias index over one issue snapshot.

Source

pub fn duplicate_ids(&self) -> &BTreeMap<String, Vec<u32>>

Every duplicated canonical id, in stable order.

Source

pub fn duplicate_id_files(&self) -> &BTreeMap<String, Vec<String>>

Every filename claiming each duplicated canonical id, in stable order.

Source

pub fn duplicate_records(&self) -> &[DuplicateIdentityRecord]

One record per file claiming a duplicated canonical id.

Source

pub fn resolve(&self, reference: &IssueRef) -> Result<IssueRef, AliasError>

Resolve a stored graph reference or selector alias to one canonical reference.

Source

pub fn resolve_number(&self, number: u32) -> Result<IssueRef, AliasError>

Resolve a numeric alias, refusing ambiguity.

Source

pub fn resolve_filename(&self, filename: &str) -> Result<IssueRef, AliasError>

Resolve an exact filename alias, refusing ambiguity.

Source

pub fn resolve_title(&self, title: &str) -> Result<IssueRef, AliasError>

Resolve an exact title alias, refusing ambiguity.

Trait Implementations§

Source§

impl Clone for AliasIndex

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AliasIndex

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for AliasIndex

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for AliasIndex

Source§

impl PartialEq for AliasIndex

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for AliasIndex

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.