Struct StringId

pub struct StringId<Id, Lookup>
where
    Lookup: StrLookup,
{ /* private fields */ }

Manage identifier both as human readable string and unique number.

StringId is designed to be used with new-type pattern and use generics to adapt to different usages.

Generics

• Id - the type of the id associated with the str
• Lookup - the type who allow to lookup for str corresponding to id

The Lookup should implement StrLookup.

The constraints of Id type, depends of the type used as Lookup. With provided implementation of StrLookup Id is generated from std with cityhasher::hash, so Id should implement cityhasher::FromCityHash and could only be be u32 or u64.

The size of a StringId variable is the size of the Id type.

StrLookupEmpty is an implementation of StrLookup who don’t keep the str.

Example

#[strlookup_hashmap(key = u32, store = StringStrStore, size = 128)]
struct CustomIdLookup;

#[derive(Debug, Clone, Copy, StringIdImpl)]
struct CustomId(StringId<u32, CustomIdLookup>);

// Create an id from the str 'resource_1'
let res_id = CustomId::from_str("resource_1").unwrap();

// CustomId can be copied
let res_id_copy = res_id;
assert_eq!(res_id_copy, res_id);

// Two CustomId created from the same `str` are equal.
let res_id_bis = CustomId::from_str("resource_1").unwrap();
assert_eq!(res_id, res_id_bis);

// The StringId variable keep the size of Id. Check :
assert_eq!(
    size_of::<u32>(),
    size_of::<CustomId>()
);

Implementations

impl<Id, Lookup> StringId<Id, Lookup>

where Id: Clone + Copy, Lookup: StrLookup<Key = Id>,

pub fn id(&self) -> Id

pub fn get_str(&self) -> &str

Trait Implementations

impl<Id, Lookup> Clone for StringId<Id, Lookup>

where Id: Clone + Copy, Lookup: StrLookup<Key = Id>,

Manual implementation to avoid than Lookup should implement Clone

This happen with implementation generated by derive macro Clone.

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Id, Lookup> Debug for StringId<Id, Lookup>

where Id: Debug + Clone + Copy, Lookup: StrLookup<Key = Id>,

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

Formats the value using the given formatter.

impl<Id: Default, Lookup> Default for StringId<Id, Lookup>

where Lookup: StrLookup + Default,

fn default() -> StringId<Id, Lookup>

Returns the “default value” for a type.

impl<Id, Lookup> Display for StringId<Id, Lookup>

where Id: Clone + Copy, Lookup: StrLookup<Key = Id>,

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

Formats the value using the given formatter.

impl<Id, Lookup> FromStr for StringId<Id, Lookup>

where Id: Clone + Copy, Lookup: StrLookup<Key = Id>,

type Err = ()

The associated error which can be returned from parsing.

fn from_str(string: &str) -> Result<Self, ()>

Parses a string s to return a value of this type.

impl<Id, Lookup> Ord for StringId<Id, Lookup>

where Id: Clone + Copy + Eq, Lookup: StrLookup<Key = Id>,

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<Id, Lookup> PartialEq for StringId<Id, Lookup>

where Id: Clone + Copy + PartialEq, Lookup: StrLookup<Key = Id>,

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<Id, Lookup> PartialOrd for StringId<Id, Lookup>

where Id: Clone + Copy + PartialEq, Lookup: StrLookup<Key = Id>,

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<Id, Lookup> Copy for StringId<Id, Lookup>

where Id: Copy, Lookup: StrLookup<Key = Id>,

Manual implementation to avoid than Lookup should implement Copy

This happen with implementation generated by derive macro Copy.

impl<Id, Lookup> Eq for StringId<Id, Lookup>

where Id: Clone + Copy + PartialEq, Lookup: StrLookup<Key = Id>,