Struct calyx_frontend::PortDef

pub struct PortDef<W> {
    pub width: W,
    pub direction: Direction,
    pub attributes: Attributes,
    /* private fields */
}

Definition of a port parameterized by a width type. Ports on Primitives can be parameteris and use Width. Ports on Components cannot be parameterized and therefore use u64.

Fields

width: W

The width of the port. .

direction: Direction

The direction of the port. Only allowed to be Direction::Input or Direction::Output.

attributes: Attributes

Attributes attached to this port definition

Implementations

impl<W> PortDef<W>

pub fn new(
    name: impl Into<Id>,
    width: W,
    direction: Direction,
    attributes: Attributes
) -> Self

pub fn name(&self) -> Id

Return the name of the port definition

impl PortDef<Width>

pub fn resolve(
    self,
    binding: &LinkedHashMap<Id, u64>
) -> CalyxResult<PortDef<u64>>

Given a map from names of parameters to their values, attempt to resolve this definition. Errors if there is no binding for a required parameter binding.

Trait Implementations

impl<W: Clone> Clone for PortDef<W>

fn clone(&self) -> PortDef<W>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<W: Debug> Debug for PortDef<W>

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

Formats the value using the given formatter.