Enum UnitNameKind

pub enum UnitNameKind {
    Unescaped(String),
    Escaped {
        name: String,
        path: Vec<String>,
    },
}

The name of a verilog module

Variants

Unescaped(String)

A string that will be directly emitted in verilog. Must be a valid verilog identifier that does not clash with any keywords. The path is the underlying path which results in this entity. This is used when generating instance names to only emit the unit name and not the fully qualified path

Escaped

Any ASCII characters. Will be prepended with \ and have appended at the end to give a valid verilog identifier

Fields

name: String

path: Vec<String>

Trait Implementations

impl Clone for UnitNameKind

fn clone(&self) -> UnitNameKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UnitNameKind

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

Formats the value using the given formatter.

impl Hash for UnitNameKind

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 UnitNameKind

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

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

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

impl StructuralPartialEq for UnitNameKind