Struct lasso::RodeoReader

pub struct RodeoReader<K: Key = Spur, S: BuildHasher + Clone = RandomState> { /* fields omitted */ }

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: Key, S: BuildHasher + Clone> RodeoReader<K, S>

pub fn get<T>(&self, val: T) -> Option<K> where
    T: AsRef<str>, 

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 resolve<'a>(&'a self, key: &K) -> &'a str

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>

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

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

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

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>

Returns an iterator over the interned strings and their key values

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

Returns an iterator over the interned strings

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

Consumes the current rodeo, making 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 + Key, S: Debug + BuildHasher + Clone> Debug for RodeoReader<K, S>

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

Formats the value using the given formatter.

impl<K: Key, S: BuildHasher + Clone> Drop for RodeoReader<K, S>

Deallocate the leaked strings interned by RodeoReader

fn drop(&mut self)

Executes the destructor for this type.

impl<K: Key + Send, S: BuildHasher + Clone + Send> Send for RodeoReader<K, S>

impl<K: Key + Sync, S: BuildHasher + Clone + Sync> Sync for RodeoReader<K, S>