Struct Netlist 

pub struct Netlist<I>
where
    I: Instantiable,
{ /* private fields */ }

A netlist data structure

Implementations

impl<I> Netlist<I>

where I: Instantiable,

pub fn new(name: String) -> Rc<Self>

Creates a new netlist with the given name

pub fn reclaim(self: Rc<Self>) -> Option<Self>

Attempts to reclaim the netlist, returning Some if successful.

pub fn insert_input(self: &Rc<Self>, net: Net) -> DrivenNet<I>

Inserts an input net to the netlist

pub fn insert_input_escaped_logic_bus( self: &Rc<Self>, net: String, bw: usize, ) -> Vec<DrivenNet<I>>

Inserts a four-state logic input port to the netlist

pub fn insert_gate( self: &Rc<Self>, inst_type: I, inst_name: Identifier, operands: &[DrivenNet<I>], ) -> Result<NetRef<I>, Error>

Inserts a gate to the netlist

pub fn insert_gate_disconnected( self: &Rc<Self>, inst_type: I, inst_name: Identifier, ) -> NetRef<I>

Use interior mutability to add an object to the netlist. Returns a mutable reference to the created object.

pub fn insert_constant( self: &Rc<Self>, value: Logic, inst_name: Identifier, ) -> Result<DrivenNet<I>, Error>

Inserts a constant Logic value to the netlist

pub fn get_driver(&self, netref: NetRef<I>, index: usize) -> Option<NetRef<I>>

Returns the driving node at input position index for netref

Panics

Panics if index is out of bounds

pub fn expose_net_with_name( &self, net: DrivenNet<I>, name: Identifier, ) -> DrivenNet<I>

Set an added object as a top-level output.

pub fn expose_net(&self, net: DrivenNet<I>) -> Result<DrivenNet<I>, Error>

Set an added object as a top-level output.

pub fn delete_net_uses(&self, netref: NetRef<I>) -> Result<Object<I>, Error>

Unlink a circuit node from the rest of the netlist. Return the object that was being stored.

pub fn replace_net_uses( &self, of: DrivenNet<I>, with: &DrivenNet<I>, ) -> Result<Object<I>, Error>

Replaces the uses of a circuit node with another circuit node. The Object stored at of is returned.

impl<I> Netlist<I>

where I: Instantiable,

pub fn get_name(&self) -> Ref<'_, String>

Returns the name of the netlist module

pub fn set_name(&self, name: String)

Sets the name of the netlist module

Panics

Panics if the module name cannot be borrowed mutably.

pub fn get_input_ports(&self) -> impl Iterator<Item = Net>

Iterates over the input ports of the netlist.

pub fn get_output_ports(&self) -> Vec<Net>

Returns a list of output nets

pub fn get_analysis<'a, A: Analysis<'a, I>>(&'a self) -> Result<A, Error>

Constructs an analysis of the netlist.

pub fn find_net(&self, net: &Net) -> Option<DrivenNet<I>>

Finds the first circuit node that drives the net. This operation is O(n). This should be unique provided the netlist is well-formed.

pub fn first(&self) -> Option<NetRef<I>>

Returns a NetRef to the first circuit node

pub fn last(&self) -> Option<NetRef<I>>

Returns a NetRef to the last circuit node

pub fn drives_an_output(&self, netref: NetRef<I>) -> bool

Returns true if an output of netref which is driving a module output.

pub fn clean_once(&self) -> Result<bool, Error>

Cleans unused nodes from the netlist, returning Ok(true) if the netlist changed.

pub fn clean(&self) -> Result<bool, Error>

Greedly removes unused nodes from the netlist, until it stops changing. Returns true if the netlist was changed.

pub fn verify(&self) -> Result<(), Error>

Verifies that a netlist is well-formed.

impl<I> Netlist<I>

where I: Instantiable,

pub fn objects(&self) -> impl Iterator<Item = NetRef<I>>

Returns an iterator over the circuit nodes in the netlist.

pub fn matches<F>(&self, filter: F) -> impl Iterator<Item = NetRef<I>>

where F: Fn(&I) -> bool,

Returns an iterator over the circuit nodes that match the instance type.

pub fn inputs(&self) -> impl Iterator<Item = DrivenNet<I>>

Returns an iterator to principal inputs in the netlist as references.

pub fn outputs(&self) -> Vec<(DrivenNet<I>, Net)>

Returns an iterator to circuit nodes that drive an output in the netlist.

pub fn connections(&self) -> impl Iterator<Item = Connection<I>>

Returns an iterator over the wire connections in the netlist.

pub fn dfs(&self, from: NetRef<I>) -> impl Iterator<Item = NetRef<I>>

Returns a depth-first search iterator over the nodes in the netlist.

Trait Implementations

impl<I> Debug for Netlist<I>

where I: Instantiable + Debug,

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

Formats the value using the given formatter.

impl<I> Display for Netlist<I>

where I: Instantiable,

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

Formats the value using the given formatter.

impl<'a, I> IntoIterator for &'a Netlist<I>

where I: Instantiable,

type Item = Net

The type of the elements being iterated over.

type IntoIter = NetIterator<'a, I>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.