Struct Cell

pub struct Cell {
    pub ports: SmallVec<[RRC<Port>; 10]>,
    pub prototype: CellType,
    pub attributes: Attributes,
    /* private fields */
}

Represents an instantiated cell.

Fields

ports: SmallVec<[RRC<Port>; 10]>

Ports on this cell

prototype: CellType

Underlying type for this cell

attributes: Attributes

Attributes for this group.

Implementations

impl Cell

pub fn new(name: Id, prototype: CellType) -> Self

Construct a cell

pub fn is_reference(&self) -> bool

Get a boolean describing whether the cell is external.

pub fn set_reference(&mut self, reference: bool) -> bool

Set the external field

pub fn find<S>(&self, name: S) -> Option<RRC<Port>>

where S: Display + Clone, Id: PartialEq<S>,

Get a reference to the named port if it exists.

pub fn find_all_with_attr<A>( &self, attr: A, ) -> impl Iterator<Item = RRC<Port>> + '_

where A: Into<Attribute>,

Return all ports that have the attribute attr.

pub fn find_unique_with_attr<A>( &self, attr: A, ) -> CalyxResult<Option<RRC<Port>>>

where A: Into<Attribute>,

Return the unique port with the given attribute. If multiple ports have the same attribute, then we panic. If there are not ports with the give attribute, then we return None.

pub fn get<S>(&self, name: S) -> RRC<Port>

where S: Display + Clone, Id: PartialEq<S>,

Get a reference to the named port and throw an error if it doesn’t exist.

pub fn is_component(&self) -> bool

Returns true iff this cell is an instance of a Calyx-defined component.

pub fn is_this(&self) -> bool

Returns true iff this cell is the signature of the current component

pub fn is_primitive<S>(&self, prim: Option<S>) -> bool

where Id: PartialEq<S>,

Returns true if this is an instance of a primitive. If the optional name is provided then only returns true if the primitive has the given name.

pub fn get_unique_with_attr<A>(&self, attr: A) -> CalyxResult<RRC<Port>>

where A: Into<Attribute> + Display + Copy,

Get the unique port with the given attribute. Panic if no port with the attribute is found and returns an error if multiple ports with the attribute are found.

pub fn type_name(&self) -> Option<Id>

Returns the name of the component that is this cells type.

pub fn get_parameter<S>(&self, param: S) -> Option<u64>

where Id: PartialEq<S>,

Get parameter binding from the prototype used to build this cell.

pub fn constant_name(val: u64, width: u64) -> Id

Return the canonical name for the cell generated to represent this (val, width) constant.

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

Return the value associated with this attribute key.

pub fn add_attribute<A: Into<Attribute>>(&mut self, attr: A, value: u64)

Add a new attribute to the group.

pub fn name(&self) -> Id

Grants immutable access to the name of this cell.

pub fn ports(&self) -> &SmallVec<[RRC<Port>; 10]>

Returns a reference to all super::Port attached to this cells.

pub fn get_signature(&self) -> Vec<PortDef<u64>>

pub fn is_comb_cell(&self) -> bool

Trait Implementations

impl Clone for Cell

fn clone(&self) -> Cell

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Cell

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

Formats the value using the given formatter.

impl GetAttributes for Cell

fn get_attributes(&self) -> &Attributes

Returns an Attributes instance

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

Returns a mutable Attributes instance

impl GetName for Cell

fn name(&self) -> Id

Return a reference to the object’s name