Struct scir::Cell

pub struct Cell { /* private fields */ }

A cell.

Implementations

impl Cell

pub fn new(name: impl Into<ArcStr>) -> Self

Creates a new cell with the given name.

pub fn add_node(&mut self, name: impl Into<ArcStr>) -> SliceOne

Creates a new 1-bit signal in this cell.

pub fn add_bus(&mut self, name: impl Into<ArcStr>, width: usize) -> Slice

Creates a new 1-dimensional bus in this cell.

pub fn expose_port(&mut self, signal: impl Into<SignalId>, direction: Direction)

Exposes the given signal as a port.

If the signal is a bus, the entire bus is exposed. It is not possible to expose only a portion of a bus. Create two separate buses instead.

Panics

Panics if the provided signal does not exist.

pub fn name(&self) -> &ArcStr

The name of the cell.

pub fn ports(&self) -> impl Iterator<Item = &Port>

Iterate over the ports of this cell.

pub fn port(&self, name: &str) -> &Port

Get a port of this cell by name.

Panics

Panics if the provided port does not exist.

pub fn signals(&self) -> impl Iterator<Item = (SignalId, &SignalInfo)>

Iterate over the signals of this cell.

pub fn signal(&self, id: SignalId) -> &SignalInfo

Get the signal associated with the given ID.

Panics

Panics if no signal with the given ID exists.

pub fn try_signal(&self, id: SignalId) -> Option<&SignalInfo>

Get the signal associated with the given ID.

pub fn signal_named(&self, name: &str) -> &SignalInfo

Get the signal associated with the given name.

Panics

Panics if no signal with the given name exists.

pub fn try_signal_named(&self, name: &str) -> Option<&SignalInfo>

Get the signal associated with the given ID.

pub fn instance(&self, id: InstanceId) -> &Instance

Get the instance associated with the given ID.

Panics

Panics if no instance with the given ID exists.

pub fn try_instance(&self, id: InstanceId) -> Option<&Instance>

Get the instance associated with the given ID.

pub fn instance_named(&self, name: &str) -> &Instance

Gets the instance with the given name.

Panics

Panics if no instance has the given name.

pub fn try_instance_named(&self, name: &str) -> Option<&Instance>

Gets the instance with the given name.

pub fn instance_from_path_element( &self, elem: &InstancePathElement ) -> &Instance

Gets the instance associated with the given path element.

pub fn add_instance(&mut self, instance: Instance) -> InstanceId

Add the given instance to the cell.

pub fn instances(&self) -> impl Iterator<Item = (InstanceId, &Instance)>

Iterate over the instances of this cell.

Trait Implementations

impl Clone for Cell

fn clone(&self) -> Cell

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Cell

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Cell

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Cell

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

where __S: Serializer,

Serialize this value into the given Serde serializer.