Skip to main content

MetaItem

Enum MetaItem 

Source
pub enum MetaItem {
    None,
    Set(Vec<MetaItemId>),
    Source {
        file: MetaStringId,
        start: SourcePosition,
        end: SourcePosition,
    },
    NamedScope {
        name: MetaStringId,
        source: MetaItemId,
        parent: MetaItemId,
    },
    IndexedScope {
        index: i32,
        source: MetaItemId,
        parent: MetaItemId,
    },
    Ident {
        name: MetaStringId,
        scope: MetaItemId,
    },
    Attr {
        name: MetaStringId,
        value: ParamValue,
    },
}
Expand description

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(Vec<MetaItemId>)

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: MetaStringId

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: MetaStringId

Name. Must not be empty.

§source: MetaItemId

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

§parent: MetaItemId

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: MetaItemId

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

§parent: MetaItemId

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

§

Ident

Identifier within source code.

Fields

§name: MetaStringId

Name. Must not be empty.

§scope: MetaItemId

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

§

Attr

Fields

§name: MetaStringId

Name. Must not be empty.

§value: ParamValue

Value.

Implementations§

Source§

impl MetaItem

Source

pub fn validate(&self, design: &Design)

Trait Implementations§

Source§

impl Clone for MetaItem

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MetaItem

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for MetaItem

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for MetaItem

Source§

impl Hash for MetaItem

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for MetaItem

Source§

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

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. Read more
Source§

impl PartialEq for MetaItem

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialOrd for MetaItem

Source§

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl StructuralPartialEq for MetaItem

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.