Struct Key 

pub struct Key { /* private fields */ }

The identity of something an application names, built from any hashable value.

A key carries the value’s type as well as its hash, so keys built from equal values of the same type are equal and keys of different types never are. An application’s own enums are therefore its natural keys, and one name cannot collide with another concern’s.

use urushi::Key;

#[derive(Hash)]
enum Pane {
    Preview,
    Chart,
}

assert_eq!(Key::of(&Pane::Preview), Key::of(&Pane::Preview));
assert_ne!(Key::of(&Pane::Preview), Key::of(&Pane::Chart));
assert_eq!(Key::from("preview"), Key::of(&"preview"));
assert_eq!(format!("{:?}", Key::from("preview")), "Key(preview)");

The value itself is not kept: a key is a type and a hash, which is what lets it name anything without owning it. Two distinct values of one type whose hashes collide are therefore one key, as they are in any hash map.

What it does keep is a label to print, and only one that costs nothing to hold: the literal for a key built from one, and the type’s name otherwise. A key stays Copy, and a log line says which key rather than which hash.

Implementations

impl Key

pub fn of<T: Hash + 'static>(value: &T) -> Self

Builds the key of value.

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Key

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

Formats the value using the given formatter.

impl From<&'static str> for Key

fn from(name: &'static str) -> Self

Converts to this type from the input type.

impl Hash for Key

fn hash<H: Hasher>(&self, hasher: &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 PartialEq for Key

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 Copy for Key

impl Eq for Key