Struct libreda_pnr::db::Pin

pub struct Pin { /* fields omitted */ }

Definition of a pin into a circuit. TODO: Make multi-bit capable.

Implementations

impl Pin

pub fn new<S>(name: S, direction: Direction) -> Pin where
    S: Into<String>, 

Create a new pin with a name and a direction.

pub fn new_input<S>(name: S) -> Pin where
    S: Into<String>, 

Convenience function to create a new input pin with a name.

pub fn new_output<S>(name: S) -> Pin where
    S: Into<String>, 

Convenience function to create a new output pin with a name.

pub fn name(&self) -> &String

Get the name of the pin.

pub fn direction(&self) -> Direction

Return the input/output direction of the pin.

pub fn set_direction(&self, direction: Direction) -> Direction

Set a new pin direction and return the old one.

pub fn id(&self) -> usize

Get the ID of the pin.

pub fn connect_net(&self, net: Option<Rc<Net>>) -> Option<Rc<Net>>

Connect the pin to the given net or disconnect it if None is given as a net. This is a shortcut for calling connect_pin_by_id on the parent circuit instance. Returns the previously connected net.

Panics

Panics if the parent circuit does not exist anymore. TODO: Remove this and use the connect_pin function on the parent circuit?

pub fn disconnect_net(&self) -> Option<Rc<Net>>

Disconnect the pin from the internal net. This is a shortcut for calling connect_pin_by_id on the parent circuit instance. Returns the previously connected net. TODO: Remove this and use the connect_pin function on the parent circuit?

pub fn internal_net(&self) -> Option<Rc<Net>>

Get the net that is internally connected to this pin, if any.

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

Get the circuit where this net lives in.

Trait Implementations

impl Clone for Pin

pub fn clone(&self) -> Pin

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Pin

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

Formats the value using the given formatter.

impl Eq for Pin

impl Hash for Pin

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

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

Pins are considered equal if they have the same parent circuit and the same ID number.

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

This method tests for !=.