Struct lasso::RodeoResolver

pub struct RodeoResolver<K = Spur> { /* private fields */ }

A read-only view of a Rodeo or ThreadedRodeo that allows contention-free access to interned strings with only key to string resolution

The key type is the same as the Rodeo or ThreadedRodeo that created it

Implementations

impl<K> RodeoResolver<K>

pub fn resolve<'a>(&'a self, key: &K) -> &'a strwhere
    K: Key,

Resolves a string by its key. Only keys made by the current Resolver or the creator of the current Resolver may be used

Panics

Panics if the key is out of bounds

Example

use lasso::Rodeo;

// ThreadedRodeo is interchangeable for Rodeo here
let mut rodeo = Rodeo::default();
let key = rodeo.get_or_intern("Strings of things with wings and dings");

let rodeo = rodeo.into_resolver();
assert_eq!("Strings of things with wings and dings", rodeo.resolve(&key));

pub fn try_resolve<'a>(&'a self, key: &K) -> Option<&'a str>where
    K: Key,

Resolves a string by its key, returning None if the key is out of bounds. Only keys made by the current Resolver or the creator of the current Resolver may be used

Example

use lasso::Rodeo;

// ThreadedRodeo is interchangeable for Rodeo here
let mut rodeo = Rodeo::default();
let key = rodeo.get_or_intern("Strings of things with wings and dings");

let rodeo = rodeo.into_resolver();
assert_eq!(Some("Strings of things with wings and dings"), rodeo.try_resolve(&key));

pub unsafe fn resolve_unchecked<'a>(&'a self, key: &K) -> &'a strwhere
    K: Key,

Resolves a string by its key without preforming bounds checks

Safety

The key must be valid for the current interner

Example

use lasso::Rodeo;

// ThreadedRodeo is interchangeable for Rodeo here
let mut rodeo = Rodeo::default();
let key = rodeo.get_or_intern("Strings of things with wings and dings");

let rodeo = rodeo.into_resolver();
unsafe {
    assert_eq!("Strings of things with wings and dings", rodeo.resolve_unchecked(&key));
}

pub fn contains_key(&self, key: &K) -> boolwhere
    K: Key,

Returns true if the given key exists in the current interner

Example

use lasso::Rodeo;

let mut rodeo = Rodeo::default();
let key = rodeo.get_or_intern("Strings of things with wings and dings");

let rodeo = rodeo.into_resolver();
assert!(rodeo.contains_key(&key));
assert!(!rodeo.contains_key(&key_that_doesnt_exist));

pub fn len(&self) -> usize

Gets the number of interned strings

Example

use lasso::Rodeo;

// ThreadedRodeo is interchangeable for Rodeo here
let mut rodeo = Rodeo::default();
rodeo.get_or_intern("Documentation often has little hidden bits in it");

let rodeo = rodeo.into_resolver();
assert_eq!(rodeo.len(), 1);

pub fn is_empty(&self) -> bool

Returns true if there are no currently interned strings

Example

use lasso::Rodeo;

// ThreadedRodeo is interchangeable for Rodeo here
let rodeo = Rodeo::default();

let rodeo = rodeo.into_resolver();
assert!(rodeo.is_empty());

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

Returns an iterator over the interned strings and their key values

pub fn strings(&self) -> Strings<'_, K>

Returns an iterator over the interned strings

Trait Implementations

impl<K: Debug> Debug for RodeoResolver<K>

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

Formats the value using the given formatter.

impl<K: Key> Index<K> for RodeoResolver<K>

type Output = str

The returned type after indexing.

fn index(&self, idx: K) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a, K: Key> IntoIterator for &'a RodeoResolver<K>

type Item = (K, &'a str)

The type of the elements being iterated over.

type IntoIter = Iter<'a, K>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<K, S> PartialEq<Rodeo<K, S>> for RodeoResolver<K>

fn eq(&self, other: &Rodeo<K, S>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<K, S> PartialEq<RodeoReader<K, S>> for RodeoResolver<K>

fn eq(&self, other: &RodeoReader<K, S>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<K, S> PartialEq<RodeoResolver<K>> for Rodeo<K, S>

fn eq(&self, other: &RodeoResolver<K>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<K, S> PartialEq<RodeoResolver<K>> for RodeoReader<K, S>

fn eq(&self, other: &RodeoResolver<K>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<K> PartialEq<RodeoResolver<K>> for RodeoResolver<K>

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<K, S> PartialEq<RodeoResolver<K>> for ThreadedRodeo<K, S>where
    K: Eq + Hash + Key,
    S: Clone + BuildHasher,

fn eq(&self, other: &RodeoResolver<K>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<K> Resolver<K> for RodeoResolver<K>where
    K: Key,

fn resolve<'a>(&'a self, key: &K) -> &'a str

Resolves the given key into a string

fn try_resolve<'a>(&'a self, key: &K) -> Option<&'a str>

Attempts to resolve the given key into a string, returning None if it cannot be found

unsafe fn resolve_unchecked<'a>(&'a self, key: &K) -> &'a str

Resolves a string by its key without preforming bounds checks

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

Returns true if the current interner contains the given key

fn len(&self) -> usize

Gets the number of currently interned strings

fn is_empty(&self) -> bool

Returns true if there are no currently interned strings

impl<K> Eq for RodeoResolver<K>

impl<K: Send> Send for RodeoResolver<K>

impl<K: Sync> Sync for RodeoResolver<K>