Enum substrate::scir::validation::Cause

pub enum Cause {
    DuplicateCellNames {
        id1: CellId,
        id2: CellId,
        name: ArcStr,
    },
    DuplicateInstanceNames {
        inst_name: ArcStr,
        cell_id: CellId,
        cell_name: ArcStr,
    },
    DuplicateSignalNames {
        id1: SignalId,
        id2: SignalId,
        name: ArcStr,
        cell_id: CellId,
        cell_name: ArcStr,
    },
    ShortedPorts {
        signal: SignalId,
        name: ArcStr,
        cell_id: CellId,
        cell_name: ArcStr,
    },
    MissingSignal {
        id: SignalId,
        cell_id: CellId,
        cell_name: ArcStr,
    },
    MissingChild {
        child_id: ChildId,
        parent_cell_id: CellId,
        parent_cell_name: ArcStr,
        instance_name: ArcStr,
    },
    UnconnectedPort {
        child_cell_id: CellId,
        child_cell_name: ArcStr,
        port: ArcStr,
        parent_cell_id: CellId,
        parent_cell_name: ArcStr,
        instance_name: ArcStr,
    },
    ExtraPort {
        child_cell_id: CellId,
        child_cell_name: ArcStr,
        port: ArcStr,
        parent_cell_id: CellId,
        parent_cell_name: ArcStr,
        instance_name: ArcStr,
    },
    IndexOutOfBounds {
        idx: usize,
        width: usize,
        cell_id: CellId,
        cell_name: ArcStr,
    },
    MissingIndex {
        signal_name: ArcStr,
        cell_id: CellId,
        cell_name: ArcStr,
    },
    IndexedWire {
        signal_name: ArcStr,
        cell_id: CellId,
        cell_name: ArcStr,
    },
    PortWidthMismatch {
        expected_width: usize,
        actual_width: usize,
        instance_name: ArcStr,
        port: ArcStr,
        parent_cell_id: CellId,
        parent_cell_name: ArcStr,
        child_cell_id: CellId,
        child_cell_name: ArcStr,
    },
}

The cause of a SCIR error or warning.

Variants

DuplicateCellNames

Fields

id1: CellId

The ID of the first cell.

id2: CellId

The ID of the second cell.

name: ArcStr

The conflicting name.

Two or more cells have the same name.

DuplicateInstanceNames

Fields

inst_name: ArcStr

The name of the instance.

cell_id: CellId

The ID of the cell containing the offending instances.

cell_name: ArcStr

The name of the cell.

Two instances in the same cell have the same name.

DuplicateSignalNames

Fields

id1: SignalId

The ID of the first signal.

id2: SignalId

The ID of the second signal.

name: ArcStr

The name of the signal.

cell_id: CellId

The ID of the offending cell.

cell_name: ArcStr

The name of the offending cell.

Two signals in a cell have the same name.

ShortedPorts

Fields

signal: SignalId

The ID of the offending signal.

name: ArcStr

The name of the signal.

cell_id: CellId

The ID of the offending cell.

cell_name: ArcStr

The name of the offending cell.

A signal is listed as a port more than once.

MissingSignal

Fields

id: SignalId

The ID of the signal.

cell_id: CellId

The ID of the cell containing the missing signal.

cell_name: ArcStr

The name of the cell containing the missing signal.

A signal identifier is used but not declared.

MissingChild

Fields

child_id: ChildId

The ID of the child cell.

parent_cell_id: CellId

The ID of the parent cell.

parent_cell_name: ArcStr

The name of the parent cell.

instance_name: ArcStr

The name of the offending instance.

An instance in a parent cell references a child not present in the library.

UnconnectedPort

Fields

child_cell_id: CellId

The ID of the child cell.

child_cell_name: ArcStr

The name of the child cell.

port: ArcStr

The name of the unconnected port.

parent_cell_id: CellId

The ID of the cell containing the offending instance.

parent_cell_name: ArcStr

The name of the cell containing the offending instance.

instance_name: ArcStr

The name of the instance in the parent cell.

An instance does not specify a connection to a port of its child cell.

ExtraPort

Fields

child_cell_id: CellId

The ID of the child cell.

child_cell_name: ArcStr

The name of the child cell.

port: ArcStr

The name of the port the instance is trying to connect.

parent_cell_id: CellId

The ID of the cell containing the offending instance.

parent_cell_name: ArcStr

The name of the cell containing the offending instance.

instance_name: ArcStr

The name of the offending instance in the parent cell.

An instance specifies a connection to a port that does not exist in the child cell.

IndexOutOfBounds

Fields

idx: usize

The out-of-bounds index.

width: usize

The width of the signal.

cell_id: CellId

The ID of the offending cell.

cell_name: ArcStr

The name of the offending cell.

A bus index is out of bounds given the width of the bus.

MissingIndex

Fields

signal_name: ArcStr

The name of the signal.

cell_id: CellId

The ID of the offending cell.

cell_name: ArcStr

The name of the offending cell.

Used a bus without indexing into it.

IndexedWire

Fields

signal_name: ArcStr

The name of the signal.

cell_id: CellId

The ID of the offending cell.

cell_name: ArcStr

The name of the offending cell.

Attempted to index a single wire.

PortWidthMismatch

Fields

expected_width: usize

The expected width of the connection.

actual_width: usize

The actual width of the connection.

instance_name: ArcStr

The name of the offending instance.

port: ArcStr

The name of the port with the invalid connection.

parent_cell_id: CellId

The ID of the parent cell.

parent_cell_name: ArcStr

The name of the parent cell.

child_cell_id: CellId

The ID of the child cell.

child_cell_name: ArcStr

The name of the child cell.

An instance specified a connection of incorrect width.

Trait Implementations

impl Clone for Cause

fn clone(&self) -> Cause

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Cause

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Cause

fn deserialize<__D>( __deserializer: __D ) -> Result<Cause, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Cause

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

Formats the value using the given formatter.

impl Hash for Cause

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

where __H: Hasher,

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 PartialEq for Cause

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Cause

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Cause

impl StructuralPartialEq for Cause