Struct StringId 

pub struct StringId(/* private fields */);

Opaque string identifier for interned strings.

StringId provides a type-safe index into the StringInterner. All symbol names, file paths, and other strings are interned to reduce memory usage and enable fast equality comparison.

Thread Safety

StringId is Copy and Send + Sync. The actual string data lives in the StringInterner which handles thread safety.

Example

let interner = StringInterner::new();
let id1 = interner.intern("hello");
let id2 = interner.intern("hello");
assert_eq!(id1, id2);  // Same string = same ID

Implementations

impl StringId

pub const LOCAL_TAG_BIT: u32

Bit used to tag staging-local StringIds.

Staging-local StringIds are allocated by GraphBuildHelper and must be remapped via StagingGraph::commit_strings() + StagingGraph::apply_string_remap() before being committed to the main graph.

Global (interner) StringIds MUST NEVER have this bit set.

pub const INVALID: StringId

Invalid sentinel value used to represent “no string” or empty.

pub const fn new(index: u32) -> Self

Creates a new StringId from a raw index.

Arguments

• index - The interner index for this string

Safety Note

This should only be called by the StringInterner. Using an index that doesn’t correspond to an interned string will cause panics when resolving.

pub const fn new_local(local_index: u32) -> Self

Creates a new staging-local StringId.

The returned StringId is guaranteed to be distinguishable from any global (interner) StringId by having Self::LOCAL_TAG_BIT set.

pub const fn is_local(self) -> bool

Returns true if this is a staging-local StringId.

pub const fn local_index(self) -> Option<u32>

If this is a staging-local StringId, returns its local index.

pub const fn index(self) -> u32

Returns the raw index value.

pub const fn as_usize(self) -> usize

Returns the index as usize for array indexing.

pub const fn is_invalid(self) -> bool

Checks if this is the invalid sentinel value.

pub const fn is_valid(self) -> bool

Checks if this is a valid (non-sentinel) ID.

Trait Implementations

impl Clone for StringId

fn clone(&self) -> StringId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StringId

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

Formats the value using the given formatter.

impl Default for StringId

fn default() -> Self

Returns StringId::INVALID as the default value.

impl<'de> Deserialize<'de> for StringId

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for StringId

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

Formats the value using the given formatter.

impl From<u32> for StringId

fn from(index: u32) -> Self

Converts to this type from the input type.

impl From<usize> for StringId

fn from(index: usize) -> Self

Converts to this type from the input type.

impl Hash for StringId

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 Ord for StringId

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

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

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for StringId

impl Eq for StringId

impl StructuralPartialEq for StringId