Struct lasso::RodeoReader[−][src]

pub struct RodeoReader<K = Spur, S = RandomState> { /* fields omitted */ }

Expand description

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

The key and hasher types are the same as the Rodeo or ThreadedRodeo that created it, can be acquired with the into_reader methods.

Implementations

`impl<K, S> RodeoReader<K, S>`[src]

`pub fn get<T>(&self, val: T) -> Option<K> where T: AsRef<str>, S: BuildHasher, K: Key,` [src]

Get the key value of a string, returning None if it doesn’t exist

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_reader();
assert_eq!(Some(key), rodeo.get("Strings of things with wings and dings"));

assert_eq!(None, rodeo.get("This string isn't interned"));

`pub fn contains<T>(&self, val: T) -> bool where T: AsRef<str>, S: BuildHasher, K: Key,` [src]

Returns true if the given string has been interned

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_reader();
assert!(rodeo.contains("Strings of things with wings and dings"));

assert!(!rodeo.contains("This string isn't interned"));

`pub fn contains_key(&self, key: &K) -> bool where K: Key,` [src]

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_reader();
assert!(rodeo.contains_key(&key));
assert!(!rodeo.contains_key(&key_that_doesnt_exist));

`pub fn resolve<'a>(&'a self, key: &K) -> &'a str where K: Key,` [src]

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,` [src]

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 str where K: Key,` [src]

Resolves a string by its key without bounds checks

Safety

The key must be valid for the current Reader

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 len(&self) -> usize`[src]

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_reader();
assert_eq!(rodeo.len(), 1);

`pub fn is_empty(&self) -> bool`[src]

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_reader();
assert!(rodeo.is_empty());

`pub fn iter(&self) -> Iter<'_, K>ⓘNotable traits for Iter<'a, K> impl<'a, K> Iterator for Iter<'a, K> where K: Key, type Item = (K, &'a str);`[src]

Returns an iterator over the interned strings and their key values

`pub fn strings(&self) -> Strings<'_, K>ⓘNotable traits for Strings<'a, K> impl<'a, K> Iterator for Strings<'a, K> type Item = &'a str;`[src]

Returns an iterator over the interned strings

`#[must_use] pub fn into_resolver(self) -> RodeoResolver<K>`[src]

Consumes the current rodeo and makes it into a RodeoResolver, allowing contention-free access from multiple threads with the lowest possible memory consumption

Example

use lasso::Rodeo;

// ThreadedRodeo is interchangeable for Rodeo here
let mut rodeo = Rodeo::default();
let key = rodeo.get_or_intern("Appear weak when you are strong, and strong when you are weak.");
let reader_rodeo = rodeo.into_reader();

let resolver_rodeo = reader_rodeo.into_resolver();
assert_eq!(
    "Appear weak when you are strong, and strong when you are weak.",
    resolver_rodeo.resolve(&key),
);

Trait Implementations

`impl<K: Debug, S: Debug> Debug for RodeoReader<K, S>`[src]

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

Formats the value using the given formatter. Read more

`impl<'de, K: Key, S: BuildHasher + Default> Deserialize<'de> for RodeoReader<K, S>`[src]

`fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where D: Deserializer<'de>,` [src]

Deserialize this value from the given Serde deserializer. Read more

`impl<K, S> Index<K> for RodeoReader<K, S> where K: Key, S: BuildHasher,` [src]

`type Output = str`

The returned type after indexing.

`fn index(&self, idx: K) -> &Self::Output`[src]

Performs the indexing (container[index]) operation. Read more

`impl<'a, K: Key, S> IntoIterator for &'a RodeoReader<K, S>`[src]

`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`[src]

Creates an iterator from a value. Read more

`impl<K, S> IntoResolver<K> for RodeoReader<K, S> where K: Key, S: BuildHasher,` [src]

`type Resolver = RodeoResolver<K>`

The type of Resolver the reader will be converted into

`#[must_use] fn into_resolver(self) -> Self::Resolver where Self: 'static,` [src]

Consumes the current Reader and makes it into a Resolver, allowing contention-free access from multiple threads with the lowest possible memory consumption Read more