Struct libreda_db::reference_access::NetRef

pub struct NetRef<'a, N: NetlistBase + ?Sized> {
    pub(super) base: &'a N,
    pub(super) id: N::NetId,
}

A reference to a net. This is just a wrapper around a netlist and a net ID.

Fields

base: &'a N

Reference to the parent data structure.

id: N::NetId

ID of the net.

Implementations

impl<'a, L: L2NBase> NetRef<'a, L>

pub fn each_shape(&self) -> impl Iterator<Item = ShapeRef<'_, L>>

Iterate over all shapes attached to this net.

impl<'a, N: NetlistBase> NetRef<'a, N>

pub fn id(&self) -> N::NetId

Get the net ID.

pub fn name(&self) -> Option<N::NameType>

Get the name of the net.

pub fn parent(&self) -> CellRef<'a, N>

Get the cell where this net lives in.

pub fn each_pin(&self) -> impl Iterator<Item = PinRef<'a, N>> + '_

Iterate over each pin attached to this net.

pub fn each_pin_instance(&self) -> impl Iterator<Item = PinInstRef<'a, N>> + '_

Iterate over each pin instance attached to this net.

pub fn each_terminal(&self) -> impl Iterator<Item = TerminalRef<'a, N>> + '_

Iterate over terminal attached to this net.

pub fn each_driver(&self) -> impl Iterator<Item = TerminalRef<'a, N>> + '_

Iterate over all terminals that drive the net. This should usually be one. Returns the pins that are marked as inputs and pin instances marked as outputs. Skips InOut terminals.

pub fn each_sink(&self) -> impl Iterator<Item = TerminalRef<'a, N>> + '_

Iterate over all terminals that drive the net. This should usually be one. Returns the pins that are marked as inputs and pin instances marked as outputs. Skips InOut terminals.

pub fn qname(&self, separator: &str) -> String

Get a qualified name for this net.

pub fn num_pins(&self) -> usize

Get the number of external pins attached to this net (pins towards the outside of the circuit).

pub fn num_pin_instances(&self) -> usize

Get the number of pin instances attached to this net. Excludes the pins towards the outside of the circuit.

pub fn num_terminals(&self) -> usize

Get the total number of pins and pin instances connected to this net.

Trait Implementations

impl<'a, N: NetlistBase> PartialEq<NetRef<'a, N>> for NetRef<'a, N>

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

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, N: NetlistBase> Eq for NetRef<'a, N>