Struct libreda_db::chip::CircuitRef

pub struct CircuitRef<'a> { /* fields omitted */ }

A ‘fat’ reference to a circuit.

Implementations

impl<'a> CircuitRef<'a>

pub fn each_instance_ref(
    &self
) -> impl Iterator<Item = CircuitInstanceRef<'_>> + ExactSizeIterator

Iterate over all cell instances in this circuit.

pub fn instance_ref_by_name(self, name: &str) -> Option<CircuitInstanceRef<'a>>

Find a child cell instance by its name. Returns None if no such instance exists.

pub fn each_dependency_ref(
    &self
) -> impl Iterator<Item = CircuitRef<'_>> + ExactSizeIterator

Iterate over the references to all cells that are dependencies of this cell.

pub fn each_dependent_cell_ref(
    &self
) -> impl Iterator<Item = CircuitRef<'_>> + ExactSizeIterator

Iterate over the references to all cells that are dependent on this cell.

pub fn each_pin_id(
    &'a self
) -> impl Iterator<Item = PinId> + ExactSizeIterator + 'a

Iterate over the IDs of the external circuit pins.

pub fn each_pin_ref(
    &self
) -> impl Iterator<Item = PinRef<'_>> + ExactSizeIterator

Iterate over each pin of this circuit.

pub fn pin_ref_at(self, position: usize) -> PinRef<'a>

Get a reference to the pin at position.

pub fn netlist(self) -> &'a Chip

Get a reference to the netlist where this circuit lives.

pub fn each_net_ref(&self) -> impl Iterator<Item = NetRef<'_>>

Iterate over all nets defined in this circuit.

Methods from Deref<Target = Circuit>

pub fn id(&self) -> CellId

Get the ID of this circuit.

pub fn name(&self) -> &String

Get the name of this circuit.

pub fn instance_id_by_name(&self, name: &str) -> Option<CellInstId>

Find a child instance in this circuit by its name.

pub fn each_instance_id(
    &self
) -> impl Iterator<Item = CellInstId> + '_ + ExactSizeIterator

Iterate over the IDs of the child instances.

pub fn each_dependency_id(
    &self
) -> impl Iterator<Item = CellId> + '_ + ExactSizeIterator

Iterate over the IDs of each dependency of this circuit. A dependency is a circuit that is instantiated in self.

pub fn each_dependent_cell_id(
    &self
) -> impl Iterator<Item = CellId> + '_ + ExactSizeIterator

Iterate over the IDs of cell that depends on this circuit.

pub fn each_parent(
    &self
) -> impl Iterator<Item = CellId> + '_ + ExactSizeIterator

Iterate over the IDs of all cells that hold instances of this circuit.

pub fn each_reference(
    &self
) -> impl Iterator<Item = CellInstId> + '_ + ExactSizeIterator

Iterate over the IDs of all instances of this circuit.

pub fn each_pin_id(
    &self
) -> impl Iterator<Item = PinId> + ExactSizeIterator + '_

Iterate over the IDs of the external circuit pins.

pub fn num_pins(&self) -> usize

Return the number of pins of this circuit.

pub fn pin_id_at(&self, position: usize) -> PinId

Get the ID of the pin at position.

pub fn each_net_id(
    &self
) -> impl Iterator<Item = NetId> + ExactSizeIterator + '_

Iterate over the IDs of all nets that are defined in this circuit.

pub fn shapes(&self, layer_id: &LayerId) -> Option<&Shapes<Coord>>

Get the shape container of this layer. Returns None if the shapes object does not exist for this layer.

Trait Implementations

impl<'a> Clone for CircuitRef<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for CircuitRef<'a>

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

Formats the value using the given formatter.

impl<'a> Deref for CircuitRef<'a>

All functions of Cell are made available also for CellRef by implementation of the Deref trait.

type Target = Circuit

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a> Copy for CircuitRef<'a>