Struct Port

pub struct Port {
    pub name: Id,
    pub width: u64,
    pub direction: Direction,
    pub parent: PortParent,
    pub attributes: Attributes,
}

Represents a port on a cell.

Fields

name: Id

Name of the port

width: u64

Width of the port

direction: Direction

Direction of the port

parent: PortParent

Weak pointer to this port’s parent

attributes: Attributes

Attributes associated with this port.

Implementations

impl Port

pub fn is_hole(&self) -> bool

Checks if this port is a hole

pub fn cell_parent(&self) -> RRC<Cell>

Returns the parent of the Port which must be Cell. Throws an error otherwise.

pub fn is_constant(&self, val: u64, width: u64) -> bool

Checks if this port is a constant of value: val.

pub fn get_parent_name(&self) -> Id

Gets name of parent object.

pub fn parent_is_comb(&self) -> bool

Checks if parent is combinational component

pub fn parent_is_protected(&self) -> bool

Checks if parent is a protected cell

pub fn parent_is_fsm(&self) -> bool

Checks if the parent is an FSM. Assignments to these always need to be maintained.

pub fn canonical(&self) -> Canonical

Get the canonical representation for this Port.

pub fn get_attribute<A>(&self, attr: A) -> Option<u64>

where A: Into<Attribute>,

Returns the value of an attribute if present

pub fn has_attribute<A>(&self, attr: A) -> bool

where A: Into<Attribute>,

Returns true if the node has a specific attribute

pub fn type_equivalent(&self, other: &Port) -> bool

Returns true if the widths, name, direction, and attributes of 2 ports match. This is different than == equivalence, which only looks at parent and name.

Trait Implementations

impl Clone for Port

fn clone(&self) -> Port

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Port

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

Formats the value using the given formatter.

impl GetAttributes for Port

fn get_attributes(&self) -> &Attributes

Returns an Attributes instance

fn get_mut_attributes(&mut self) -> &mut Attributes

Returns a mutable Attributes instance

impl PartialEq for Port

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 Eq for Port