Struct StringId 

pub struct StringId<I = u16>(/* private fields */);

Identifier for one string in a crate::StringTable.

I is the backing integer type (default u16) and must implement crate::StringIndex. It limits how many strings a single table can hold, and it is what you store in your own structs to later refer to a string.

Implementations

impl<I> StringId<I>

pub const fn new(raw: I) -> Self

Creates a new ID from a raw value.

pub fn into_raw(self) -> I

Returns the raw index value.

impl<I: StringIndex> StringId<I>

pub fn into_usize(self) -> usize

Returns the value as usize.

impl StringId<u32>

pub const fn into_u32(self) -> u32

Returns the raw u32 value.

Trait Implementations

impl<I: Clone> Clone for StringId<I>

fn clone(&self) -> StringId<I>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<I: Debug> Debug for StringId<I>

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

Formats the value using the given formatter.

impl<I: Default> Default for StringId<I>

fn default() -> StringId<I>

Returns the “default value” for a type.

impl<I: Display> Display for StringId<I>

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

Formats the value using the given formatter.

impl<I> From<I> for StringId<I>

fn from(value: I) -> Self

Converts to this type from the input type.

impl From<StringId<u32>> for u32

fn from(value: StringId<u32>) -> Self

Converts to this type from the input type.

impl From<StringId<u64>> for u64

fn from(value: StringId<u64>) -> Self

Converts to this type from the input type.

impl From<StringId<u8>> for u8

fn from(value: StringId<u8>) -> Self

Converts to this type from the input type.

impl From<StringId<usize>> for usize

fn from(value: StringId<usize>) -> Self

Converts to this type from the input type.

impl From<StringId> for u16

fn from(value: StringId<u16>) -> Self

Converts to this type from the input type.

impl<I: Hash> Hash for StringId<I>

fn hash<__H: Hasher>(&self, state: &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<I: Ord> Ord for StringId<I>

fn cmp(&self, other: &StringId<I>) -> 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<I: PartialEq> PartialEq for StringId<I>

fn eq(&self, other: &StringId<I>) -> 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<I: PartialOrd> PartialOrd for StringId<I>

fn partial_cmp(&self, other: &StringId<I>) -> 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<I: Copy> Copy for StringId<I>

impl<I: Eq> Eq for StringId<I>

impl<I> StructuralPartialEq for StringId<I>