Enum MetaItem

pub enum MetaItem<'a> {
    None,
    Set(BTreeSet<MetaItemRef<'a>>),
    Source {
        file: MetaStringRef<'a>,
        start: SourcePosition,
        end: SourcePosition,
    },
    NamedScope {
        name: MetaStringRef<'a>,
        source: MetaItemRef<'a>,
        parent: MetaItemRef<'a>,
    },
    IndexedScope {
        index: i32,
        source: MetaItemRef<'a>,
        parent: MetaItemRef<'a>,
    },
    Ident {
        name: MetaStringRef<'a>,
        scope: MetaItemRef<'a>,
    },
    Attr {
        name: MetaStringRef<'a>,
        value: ParamValue,
    },
}

Metadata item.

Metadata items represent information about cells that does not affect computational semantics. Some metadata items only carry information about the source code, and other metadata items affect how the netlist is transformed.

Variants

None

Absence of a metadata item. The purpose of this variant is to make metadata indices take less memory.

Set(BTreeSet<MetaItemRef<'a>>)

Multiple metadata items. The purpose of this variant is to make collections of metadata indices take less memory. A metadata set cannot contain less than two metadata items.

Source

Source location.

Fields

file: MetaStringRef<'a>

Filename. Must not be empty.

start: SourcePosition

Start of the range (inclusive).

end: SourcePosition

End of the range (exclusive).

NamedScope

Scope identified by a name. A top-level named scope could be a module declaration. A named scope with a parent could be a block within a module.

Fields

name: MetaStringRef<'a>

Name. Must not be empty.

source: MetaItemRef<'a>

Source location. Must reference MetaItem::None or MetaItem::Source.

parent: MetaItemRef<'a>

Parent scope. Must reference MetaItem::None, MetaItem::NamedScope, or MetaItem::IndexedScope.

IndexedScope

Scope identified by an index. A top-level named scope could be a module declaration. A named scope with a parent could be a named instance of a module within another module.

Fields

index: i32

source: MetaItemRef<'a>

Source location. Must reference MetaItem::None or MetaItem::Source.

parent: MetaItemRef<'a>

Parent scope. Must reference MetaItem::None, MetaItem::NamedScope, or MetaItem::IndexedScope.

Ident

Identifier within source code.

Fields

name: MetaStringRef<'a>

Name. Must not be empty.

scope: MetaItemRef<'a>

Containing scope. Must reference a MetaItem::NamedScope, or MetaItem::IndexedScope.

Attr

Fields

name: MetaStringRef<'a>

Name. Must not be empty.

value: ParamValue

Value.

Implementations

impl MetaItem<'_>

pub fn validate(&self)

Trait Implementations

impl<'a> Clone for MetaItem<'a>

fn clone(&self) -> MetaItem<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for MetaItem<'a>

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

Formats the value using the given formatter.

impl<'a> Default for MetaItem<'a>

fn default() -> MetaItem<'a>

Returns the “default value” for a type.

impl<'a> Hash for MetaItem<'a>

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<'a> Ord for MetaItem<'a>

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

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

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

impl<'a> StructuralPartialEq for MetaItem<'a>