Struct libreda_pnr::db::CircuitInstance

pub struct CircuitInstance { /* fields omitted */ }

Represents an instantiation of a Circuit (a sub-circuit).

Implementations

impl CircuitInstance

pub fn parent_circuit(&self) -> Weak<Circuit>

Gets the parent circuit where this instance lives in.

pub fn circuit_ref(&self) -> Weak<Circuit>

Gets the circuit template referenced by this instance.

pub fn circuit_id(&self) -> Index<Circuit>

Gets the ID of the circuit template referenced by this instance.

pub fn connect_pin_by_id(
    &self,
    pin_instance_id: usize,
    net: Option<Rc<Net>>
) -> Option<Rc<Net>>

Connect a pin on the outside of the sub circuit to a net that is defined in the parent circuit.

Returns the previously connected net.

Panics

Panics if the supplied net does not exist in the parent circuit. Also panics if the referenced pin does not exist.

pub fn connect_pin(
    &self,
    pin: &Rc<PinInstance>,
    net: Option<Rc<Net>>
) -> Option<Rc<Net>>

Connect a pin on the outside of the sub circuit to a net that is defined in the parent circuit.

Returns the previously connected net.

Panics

• Panics if the pin instance does not live in this circuit instance.
• Panics if the net does not live in the same parent circuit as this circuit instance.

pub fn disconnect_pin_by_id(&self, pin_instance_id: usize) -> Option<Rc<Net>>

Disconnects a pin on the outside from the attached net. Short-cut for .connect_pin_by_id(pin_id, None).

Returns the previously connected net.

Panics

Panics if the referenced pin does not exist.

pub fn disconnect_pin(&self, pin_instance: &Rc<PinInstance>) -> Option<Rc<Net>>

Disconnects a pin on the outside from the attached net. Short-cut for .connect_pin(pin_instance, None). Returns the previously connected net.

pub fn each_pin_instance(
    &self
) -> impl ExactSizeIterator + Iterator<Item = &Rc<PinInstance>>

Iterate over all pins instances.

pub fn each_pin_instance_vec(&self) -> Vec<Rc<PinInstance>, Global>

Get a Vec with all pins instances.

pub fn id(&self) -> Index<CircuitInstance>

Get index of this circuit instance.

pub fn name(&self) -> Option<&String>

Get the name of this circuit instance.

pub fn net_for_pin(&self, pin_index: usize) -> Option<Rc<Net>>

Get the net connected to the referenced pin.

Panics

Panics if the referenced pin does not exist.

pub fn pin_count(&self) -> usize

Return the number of pins.

pub fn pin_instance_by_id(&self, pin_index: usize) -> Rc<PinInstance>

Get the pin instance by the pin ID.

Panics

Panics if the pin with this ID does not exist.

Trait Implementations

impl Debug for CircuitInstance

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

Formats the value using the given formatter.

impl Eq for CircuitInstance

impl Hash for CircuitInstance

pub fn hash<H>(&self, state: &mut H) where
    H: Hasher, 

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<CircuitInstance> for CircuitInstance

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.