Struct scir::Instance

pub struct Instance { /* private fields */ }

An instance of a child cell placed inside a parent cell.

Implementations

impl Instance

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

Create an instance of the given cell with the given name.

pub fn connect(&mut self, name: impl Into<ArcStr>, conn: impl Into<Concat>)

Connect the given port of the child cell to the given node in the parent cell.

pub fn child(&self) -> ChildId

The ID of the child cell.

This instance represents an instantiation of the child cell in a parent cell.

pub fn name(&self) -> &ArcStr

The name of this instance.

This is not necessarily the name of the child cell.

pub fn connections(&self) -> &HashMap<ArcStr, Concat>

Returns a reference to this instance’s connection map.

pub fn connections_mut(&mut self) -> &mut HashMap<ArcStr, Concat>

Returns a mutable reference to this instance’s connection map.

pub fn connection<'a>(&'a self, port: &str) -> &'a Concat

The connection to the given port.

Panics

Panics if there is no connection for the given port.

pub fn map_connections(&mut self, map_fn: impl Fn(ArcStr) -> ArcStr)

Maps the connections to this instance to new port names.

Exhibits undefined behavior if two connections map to the same port name.

Trait Implementations

impl Clone for Instance

fn clone(&self) -> Instance

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Instance

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Instance

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Instance

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

where __S: Serializer,

Serialize this value into the given Serde serializer.