Struct AliasMap

pub struct AliasMap<T> { /* private fields */ }

A map of AliasPatterns to the [Template]s they resolve to.

If a pattern has a wildcard character (*) within it, it will capture any number of characters, including path separators. The result of the capture will then be passed to the template.

If the pattern does not have a wildcard character, it will only match the exact string, and return the template as-is.

Implementations

impl<T> AliasMap<T>

pub fn new() -> Self

Creates a new alias map.

pub fn lookup<'a>( &'a self, request: &'a Pattern, ) -> AliasMapLookupIterator<'a, T>

where T: Debug,

Looks up a request in the alias map.

Returns an iterator to all the matching aliases.

pub fn lookup_with_prefix_predicate<'a>( &'a self, request: &'a Pattern, prefix_predicate: impl FnMut(&str) -> bool, ) -> AliasMapLookupIterator<'a, T>

where T: Debug,

Looks up a request in the alias map, but only returns aliases where the prefix matches a certain predicate.

Returns an iterator to all the matching aliases.

pub fn insert(&mut self, pattern: AliasPattern, template: T) -> Option<T>

Inserts a new alias into the map.

If the map did not have this alias already, None is returned.

If the map had this alias, the template is updated, and the old template is returned.

Trait Implementations

impl<T: Clone> Clone for AliasMap<T>

fn clone(&self) -> AliasMap<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for AliasMap<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Default for AliasMap<T>

fn default() -> Self

Returns the “default value” for a type.

impl<'a, T> Deserialize<'a> for AliasMap<T>

where T: Deserialize<'a>,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'a>,

Deserialize this value from the given Serde deserializer.

impl<T> Extend<(AliasPattern, T)> for AliasMap<T>

fn extend<It>(&mut self, iter: It)

where It: IntoIterator<Item = (AliasPattern, T)>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<'a, T> IntoIterator for &'a AliasMap<T>

type Item = (AliasPattern, &'a T)

The type of the elements being iterated over.

type IntoIter = AliasMapIter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T> IntoIterator for AliasMap<T>

type Item = (AliasPattern, T)

The type of the elements being iterated over.

type IntoIter = AliasMapIntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T> PartialEq for AliasMap<T>

where T: PartialEq,

fn eq(&self, other: &Self) -> 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<T> Serialize for AliasMap<T>

where T: Serialize,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> TraceRawVcs for AliasMap<T>

where T: TraceRawVcs,

fn trace_raw_vcs(&self, trace_context: &mut TraceRawVcsContext)

fn get_raw_vcs(&self) -> Vec<RawVc>

impl<T> ValueDebugFormat for AliasMap<T>

where T: ValueDebugFormat,

fn value_debug_format(&self, depth: usize) -> ValueDebugFormatString<'_>

impl<T> Eq for AliasMap<T>

where T: Eq,

impl<T: NonLocalValue> NonLocalValue for AliasMap<T>