Struct libreda_pnr::db::Net

pub struct Net { /* fields omitted */ }

Copied from KLayout: A single net. A net connects multiple pins or terminals together. Pins are either pin or subcircuits of outgoing pins of the circuit the net lives in. Terminals are connections made to specific terminals of devices. Net objects are created inside a circuit with Circuit#create_net. To connect a net to an outgoing pin of a circuit, use Circuit#connect_pin, to disconnect a net from an outgoing pin use Circuit#disconnect_pin. To connect a net to a pin of a subcircuit, use SubCircuit#connect_pin, to disconnect a net from a pin of a subcircuit, use SubCircuit#disconnect_pin. To connect a net to a terminal of a device, use Device#connect_terminal, to disconnect a net from a terminal of a device, use Device#disconnect_terminal.

Implementations

impl Net

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

Return the name of this net.

pub fn create_name(&self) -> String

Return the name of this net or if it is None create a name based on the net ID. TODO: There is no guarantee yet that this name is collision free.

pub fn create_qname(&self) -> String

Return a qualified name of this net of the form CIRCUIT_NAME:NET_NAME. TODO: There is no guarantee yet that this name is collision free.

pub fn rename<S>(&self, name: Option<S>) where
    S: Into<String>, 

Rename the net

Panics

• Panics if there is already a net with this name.

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

Get the index of this net. The index uniquely identifies this net within the circuit.

pub fn pins(&self) -> impl Deref<Target = HashSet<Rc<Pin>, RandomState>>

Get borrowed reference to the set of pins.

pub fn pins_instances(
    &self
) -> impl Deref<Target = HashSet<Rc<PinInstance>, RandomState>>

Get borrowed reference to the set of pin instances.

pub fn each_terminal(&self) -> impl Iterator<Item = TerminalRef>

Iterate over all pins and pin instances connected to this net.

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

Iterate over all pin instances connected to this net.

pub fn each_pin(&self) -> impl Iterator<Item = Rc<Pin>>

Iterate over all pins connected to this net.

pub fn each_instance(&self) -> impl Iterator<Item = Rc<CircuitInstance>>

Find each circuit instance that is connected to this net.

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

Get the circuit where this net lives in.

pub fn num_pins(&self) -> usize

Return the number of pins connected to this net.

pub fn num_pin_instances(&self) -> usize

Return the number of pin instances connected to this net.

pub fn num_terminals(&self) -> usize

Return the number of terminals (pins and pin instances) connected to this net.

Trait Implementations

impl Debug for Net

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

Formats the value using the given formatter.

impl Eq for Net

impl Hash for Net

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<Net> for Net

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

A net is considered equal if the ID and parent circuit are identical.

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

This method tests for !=.