Struct DomainMap

pub struct DomainMap<T> {
    data: Vec<(Domain, T)>,
}

A map with domain name keys, with support for wildcards

A DomainMap<T> holds “[presented identifiers]” (domain names possibly with wildcards) as Domains. A DomainMap can be indexed using a Domain, which stores either a “reference identifier” (for matching methods, e.g. get or get_mut) or a “presented identifier” (for equality-comparing methods, e.g. get_eq or remove).

Currently, this is implemented using an associative array, but this may change in the future.

Examples

use links_domainmap::{Domain, DomainMap};

// Create a new `DomainMap` with `u32` values
let mut domainmap = DomainMap::<u32>::new(); // or `with_capacity()`

// Set a value for `example.com`
domainmap.set(Domain::presented("example.com")?, 5);

// Set a value for the wildcard domain `*.example.net`
domainmap.set(Domain::presented("*.example.net")?, 100);

// Get the value for the domain matching `example.com`
assert_eq!(domainmap.get(&Domain::reference("example.com")?), Some(&5));

// Get the value for the domain matching `foo.example.net`
assert_eq!(
	domainmap.get(&Domain::reference("foo.example.net")?),
	Some(&100)
);

// Get the value for the domain `*.example.net` (using `==` internally)
assert_eq!(
	domainmap.get_eq(&Domain::presented("*.example.net")?),
	Some(&100)
);

// Try to get the value for the domain matching `a.b.c.example.net`
assert_eq!(
	domainmap.get(&Domain::reference("a.b.c.example.net")?),
	None // Wildcards only work for one label
);

// Update the value for `example.com`
let old_value = domainmap.set(Domain::presented("example.com")?, 50);
assert_eq!(old_value, Some(5));

// Modify the value for the domain matching `foo.example.net`
let val = domainmap.get_mut(&Domain::reference("foo.example.net")?);
if let Some(val) = val {
	*val += 1;
	assert_eq!(val, &101);
}

// Set a value for `www.example.net`, overriding the wildcard `*.example.net`
domainmap.set(Domain::presented("www.example.net")?, 250);

// The wildcard still exists, but is overridden for `www.example.net`
assert_eq!(
	domainmap.get(&Domain::reference("www.example.net")?),
	Some(&250)
);
assert_eq!(
	domainmap.get(&Domain::reference("other.example.net")?),
	Some(&101)
);

// Remove the entry for `example.com`
let old_value = domainmap.remove(&Domain::presented("example.com")?);
assert_eq!(old_value, Some(50));
assert_eq!(
	domainmap.get(&Domain::reference("example.com")?),
	None // Not in the map anymore
);

// Show the amount of key-value pairs in the map
assert_eq!(domainmap.len(), 2); // `*.example.net` and `www.example.net`

// Clear the map
domainmap.clear();
assert!(domainmap.is_empty());

Fields

data: Vec<(Domain, T)>

Implementations

impl<T> DomainMap<T>

pub const fn new() -> Self

Create a new empty DomainMap

pub fn with_capacity(cap: usize) -> Self

Create a new empty DomainMap with enough capacity for at least cap key-value pairs

pub fn set(&mut self, domain: Domain, value: T) -> Option<T>

Set the value for the given domain, adding a new entry if the domain was not already in the map, and returning the old value otherwise

Examples

let mut domainmap = DomainMap::<Certificate>::new();

domainmap.set(Domain::presented("example.com")?, get_certificate());

domainmap.set(Domain::presented("*.example.com")?, get_certificate());

assert!(domainmap.get(&Domain::presented("example.com")?).is_some());

pub fn get(&self, domain: &Domain) -> Option<&T>

Get the value matching the reference identifier domain

If there is a value for a wildcard domain matching the given domain, and for the given domain itself, the specific (non-wildcard) domain’s value is always returned, regardless of insertion order

Examples

let mut domainmap = DomainMap::<Certificate>::new();

domainmap.set(Domain::presented("*.example.com")?, get_certificate());

assert!(domainmap.get(&Domain::reference("example.com")?).is_none());

assert!(domainmap
	.get(&Domain::reference("www.example.com")?)
	.is_some());

let mut domainmap = DomainMap::<u64>::new();

domainmap.set(Domain::presented("foo.example.com")?, 10);
domainmap.set(Domain::presented("*.example.com")?, 50);

assert_eq!(
	domainmap.get(&Domain::reference("bar.example.com")?),
	Some(&50)
);

assert_eq!(
	domainmap.get(&Domain::reference("foo.example.com")?),
	Some(&10)
);

pub fn get_mut(&mut self, domain: &Domain) -> Option<&mut T>

Get a mutable reference to the value matching the reference identifier

If there is a value for a wildcard domain matching the given domain, and for the given domain itself, the specific (non-wildcard) domain’s value is always returned, regardless of insertion order

Examples

let mut domainmap = DomainMap::<Certificate>::new();

domainmap.set(Domain::presented("*.example.com")?, get_certificate());

assert!(domainmap
	.get_mut(&Domain::reference("example.com")?)
	.is_none());

assert!(domainmap
	.get_mut(&Domain::reference("www.example.com")?)
	.is_some());

let mut domainmap = DomainMap::<u64>::new();

domainmap.set(Domain::presented("foo.example.com")?, 10);
domainmap.set(Domain::presented("*.example.com")?, 50);

assert_eq!(
	domainmap.get_mut(&Domain::reference("bar.example.com")?),
	Some(&mut 50)
);

assert_eq!(
	domainmap.get_mut(&Domain::reference("foo.example.com")?),
	Some(&mut 10)
);

pub fn get_eq(&self, domain: &Domain) -> Option<&T>

Get the value for the given domain, checking using == instead of matching

Examples

let mut domainmap = DomainMap::<Certificate>::new();

domainmap.set(Domain::presented("*.example.com")?, get_certificate());

assert!(domainmap
	.get_eq(&Domain::presented("www.example.com")?)
	.is_none());

assert!(domainmap
	.get_eq(&Domain::presented("*.example.com")?)
	.is_some());

pub fn remove(&mut self, domain: &Domain) -> Option<T>

Remove the given domain from the map, returning its value, if any

Note that unlike DomainMap::get, this method compares the domain using == instead of checking for a match

Examples

let mut domainmap = DomainMap::<Certificate>::new();

domainmap.set(Domain::presented("*.example.com")?, get_certificate());

assert!(domainmap
	.remove(&Domain::presented("example.com")?)
	.is_none());

assert!(domainmap
	.remove(&Domain::presented("*.example.com")?)
	.is_some());

assert!(domainmap
	.remove(&Domain::presented("*.example.com")?)
	.is_none());

pub fn clear(&mut self)

Clear the DomainMap, removing all contents

Examples

let mut domainmap = DomainMap::<Certificate>::new();

domainmap.set(Domain::presented("example.com")?, get_certificate());

assert!(domainmap.get(&Domain::reference("example.com")?).is_some());

domainmap.clear();

assert!(domainmap.get(&Domain::reference("example.com")?).is_none());

pub fn len(&self) -> usize

Get the number of key-value pairs in the DomainMap

Examples

let mut domainmap = DomainMap::<Certificate>::new();

assert_eq!(domainmap.len(), 0);

domainmap.set(Domain::presented("example.com")?, get_certificate());

assert_eq!(domainmap.len(), 1);

pub fn is_empty(&self) -> bool

Check whether the DomainMap is empty, i.e. if its length is 0

Examples

let mut domainmap = DomainMap::<Certificate>::new();

assert!(domainmap.is_empty());

domainmap.set(Domain::presented("example.com")?, get_certificate());

assert!(!domainmap.is_empty());

pub fn iter(&self) -> Iter<'_, T>

Return an iterator over references to this map’s key-value pairs in unspecified order

Examples

let mut domainmap = DomainMap::<u32>::new();
domainmap.set(Domain::presented("example.com")?, 1);
let mut iterator = domainmap.iter();

assert_eq!(
	iterator.next(),
	Some((&Domain::presented("example.com")?, &1))
);
assert_eq!(iterator.next(), None);

pub fn iter_mut(&mut self) -> IterMut<'_, T>

Return an iterator over mutable references to this map’s key-value pairs in unspecified order

Examples

let mut domainmap = DomainMap::<u32>::new();
domainmap.set(Domain::presented("example.com")?, 1);
let mut iterator = domainmap.iter_mut();

assert_eq!(
	iterator.next(),
	Some((&Domain::presented("example.com")?, &mut 1))
);
assert_eq!(iterator.next(), None);

Trait Implementations

impl<T: Clone> Clone for DomainMap<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for DomainMap<T>

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

Formats the value using the given formatter.

impl<T> Default for DomainMap<T>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T: Deserialize<'de>> Deserialize<'de> for DomainMap<T>

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Extend<(Domain, T)> for DomainMap<T>

fn extend<I: IntoIterator<Item = (Domain, T)>>(&mut self, iter: I)

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<T> FromIterator<(Domain, T)> for DomainMap<T>

fn from_iter<I: IntoIterator<Item = (Domain, T)>>(iter: I) -> Self

Creates a value from an iterator.

impl<T: Hash> Hash for DomainMap<T>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a, T: 'a> IntoIterator for &'a DomainMap<T>

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

type Item = (&'a Domain, &'a T)

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T: 'a> IntoIterator for &'a mut DomainMap<T>

type IntoIter = IterMut<'a, T>

Which kind of iterator are we turning this into?

type Item = (&'a Domain, &'a mut T)

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T> IntoIterator for DomainMap<T>

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

type Item = (Domain, T)

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: PartialEq> PartialEq for DomainMap<T>

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> Serialize for DomainMap<T>

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Eq> Eq for DomainMap<T>