Struct NetRef 

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

Provides an idiomatic interface to the interior mutability of the netlist

Implementations

impl<I> NetRef<I>

where I: Instantiable,

pub fn as_net(&self) -> Ref<'_, Net>

Returns a borrow to the Net at this circuit node.

Panics

Panics if the circuit node has multiple outputs.

pub fn as_net_mut(&self) -> RefMut<'_, Net>

Returns a mutable borrow to the Net at this circuit node.

Panics

Panics if the circuit node has multiple outputs.

pub fn get_net(&self, idx: usize) -> Ref<'_, Net>

Returns a borrow to the output Net as position idx

pub fn get_net_mut(&self, idx: usize) -> RefMut<'_, Net>

Returns a mutable borrow to the output Net as position idx

pub fn get_output(&self, idx: usize) -> DrivenNet<I>

Returns a borrow to the output Net as position idx

pub fn find_output(&self, id: &Identifier) -> Option<DrivenNet<I>>

Returns a borrow to the output connected to port id

pub fn get_input(&self, idx: usize) -> InputPort<I>

Returns an abstraction around the input connection

pub fn find_input(&self, id: &Identifier) -> Option<InputPort<I>>

Returns a borrow to the input port with name id

pub fn get_identifier(&self) -> Identifier

Returns the name of the net at this circuit node.

Panics

Panics if the circuit node has multiple outputs.

pub fn set_identifier(&self, identifier: Identifier)

Changes the identifier of the net at this circuit node.

Panics

Panics if the circuit node has multiple outputs.

pub fn is_an_input(&self) -> bool

Returns true if this circuit node is a principal input

pub fn get_obj(&self) -> Ref<'_, Object<I>>

Returns a reference to the object at this node.

pub fn get_instance_type(&self) -> Option<Ref<'_, I>>

Returns the Instantiable type of the instance, if this circuit node is an instance

pub fn get_instance_type_mut(&self) -> Option<RefMut<'_, I>>

Returns the Instantiable type of the instance, if this circuit node is an instance

pub fn get_instance_name(&self) -> Option<Identifier>

Returns a copy of the name of the instance, if the circuit node is a instance.

pub fn set_instance_name(&self, name: Identifier)

Updates the name of the instance, if the circuit node is an instance.

Panics

Panics if the circuit node is a principal input.

pub fn expose_as_output(self) -> Result<Self, Error>

Exposes this circuit node as a top-level output in the netlist. Returns an error if the circuit node is a principal input.

Panics

Panics if cell is a multi-output circuit node. Panics if the reference to the netlist is lost.

pub fn expose_with_name(self, name: Identifier) -> Self

Exposes this circuit node as a top-level output in the netlist with a specific port name.

Panics

Panics if the cell is a multi-output circuit node. Panics if the reference to the netlist is lost.

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

Exposes the net driven by this circuit node as a top-level output. Errors if net is not driven by this circuit node.

Panics

Panics if the reference to the netlist is lost.

pub fn get_driver(&self, index: usize) -> Option<Self>

Returns the circuit node that drives the indexth input

pub fn get_driver_net(&self, index: usize) -> Option<Net>

Returns the net that drives the indexth input

Panics

Panics if the reference to the netlist is lost.

pub fn req_driver_net(&self, index: usize) -> Option<MutBorrowReq<I>>

Returns a request to mutably borrow the operand net This requires another borrow in the form of MutBorrowReq

Panics

Panics if the reference to the netlist is lost.

pub fn get_num_input_ports(&self) -> usize

Returns the number of input ports for this circuit node.

pub fn is_fully_connected(&self) -> bool

Returns true if this circuit node has all its input ports connected.

pub fn drivers(&self) -> impl Iterator<Item = Option<Self>>

Returns an iterator to the driving circuit nodes.

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

Returns an interator to the driving nets.

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

Returns an iterator to the output nets of this circuit node.

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

Returns an iterator to the output nets of this circuit node, along with port information.

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

Returns an iterator to the output nets of this circuit node, along with port information.

pub fn nets_mut(&self) -> impl Iterator<Item = RefMut<'_, Net>>

Returns an iterator to mutate the output nets of this circuit node.

pub fn drives_net(&self, net: &Net) -> bool

Returns true if this circuit node drives the given net.

pub fn drives_a_top_output(&self) -> bool

Returns true if this circuit node drives a top-level output.

Panics

Panics if the weak reference to the netlist is lost.

pub fn find_net_mut(&self, net: &Net) -> Option<RefMut<'_, Net>>

Attempts to find a mutable reference to net within this circuit node.

pub fn is_multi_output(&self) -> bool

Returns true if this circuit node has multiple outputs/nets.

pub fn delete_uses(self) -> Result<Object<I>, Error>

Deletes the uses of this circuit node from the netlist.

Panics

Panics if the reference to the netlist is lost.

pub fn replace_uses_with(self, other: &DrivenNet<I>) -> Result<Object<I>, Error>

Replaces the uses of this circuit node in the netlist with another circuit node.

Panics

Panics if either self is a multi-output circuit node. Panics if the weak reference to the netlist is lost.

pub fn clear_attribute(&self, k: &AttributeKey) -> Option<AttributeValue>

Clears the attribute with the given key on this circuit node.

pub fn set_attribute(&self, k: AttributeKey)

Set an attribute without a value

pub fn insert_attribute( &self, k: AttributeKey, v: String, ) -> Option<AttributeValue>

Insert an attribute on this node with a value

pub fn attributes(&self) -> impl Iterator<Item = Attribute>

Returns an iterator to the attributes at this circuit node

Trait Implementations

impl<I> Clone for NetRef<I>

where I: Instantiable + Clone,

fn clone(&self) -> NetRef<I>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<I> Debug for NetRef<I>

where I: Instantiable,

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

Formats the value using the given formatter.

impl<I> Display for NetRef<I>

where I: Instantiable,

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

Formats the value using the given formatter.

impl<I> From<&NetRef<I>> for DrivenNet<I>

where I: Instantiable,

fn from(val: &NetRef<I>) -> Self

Converts to this type from the input type.

impl<I> From<NetRef<I>> for DrivenNet<I>

where I: Instantiable,

fn from(val: NetRef<I>) -> Self

Converts to this type from the input type.

impl<I> Hash for NetRef<I>

where I: Instantiable,

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<I> PartialEq for NetRef<I>

where I: Instantiable,

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<I> Eq for NetRef<I>

where I: Instantiable,