Struct SymbolId 

pub struct SymbolId { /* private fields */ }

A unique, owned symbol key: the hierarchical path (for display and ordering) plus the chain of member indices from the root down to the symbol (for uniqueness).

Implementations

impl SymbolId

pub fn synthetic(path: &str) -> SymbolId

A key that names no real symbol, for unit tests of code that only needs keys to compare (it equals no key SymbolUid::uid produces).

pub fn path(&self) -> &str

The hierarchical path (not unique by itself – see the module doc).

pub fn synthetic_tagged(tag: &str) -> SymbolId

A key that names no symbol, for a value the simulator itself keeps in a symbol-keyed table (a procedural assertion’s const'(expr) capture, vj-codegen::sva::proc). It never equals a real symbol’s key: the member chain is the impossible [u32::MAX].

pub fn derive(&self, tag: &str) -> SymbolId

A key for storage the simulator itself adds next to this symbol (a sampled-value history cell, crate::sva::sampled): this symbol’s path plus ${tag}, with the same member chain. Two symbols never collide (their chains differ), nor do one symbol’s distinct tags (their paths differ); a derived key equals a real symbol’s only if that symbol is this one and is literally named {name}${tag}.

pub fn key_string(&self) -> String

The path and member chain as one string: a unique, deterministic text form, for building a Self::derive tag from another symbol.

Trait Implementations

impl Clone for SymbolId

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SymbolId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SymbolId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SymbolId

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

Formats the value using the given formatter.

impl Eq for SymbolId

impl Hash for SymbolId

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 SymbolId

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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for SymbolId

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SymbolId

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 Serialize for SymbolId

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SymbolId