Struct llhd::Entity

pub struct Entity { /* fields omitted */ }

An entity. Describes through its instructions the data dependencies in order to react to changes in input signals. Implements data flow and timed execution.

Methods

impl Entity

pub fn new(     name: impl Into<String>,     ty: Type ) -> Entity

Create a new entity with the given name and type signature. Anonymous arguments are created for each input and output in the type signature. Use the inputs_mut and outputs_mut functions get a hold of these arguments and assign names and additional data to them.

pub fn as_ref(&self) -> EntityRef

Obtain a reference to this entity.

pub fn name(&self) -> &str

Get the name of the entity.

pub fn input(&self, idx: usize) -> ArgumentRef

Get a graph reference to one of the inputs of the entity.

pub fn inputs(&self) -> &[Argument]

Get a reference to the input arguments of the entity.

pub fn inputs_mut(&mut self) -> &mut [Argument]

Get a mutable reference to the input arguments of the entity.

pub fn output(&self, idx: usize) -> ArgumentRef

Get a graph reference to one of the outputs of the entity.

pub fn outputs(&self) -> &[Argument]

Get a reference to the output arguments of the entity.

pub fn outputs_mut(&mut self) -> &mut [Argument]

Get a mutable reference to the output arguments of the entity.

pub fn add_inst(&mut self, inst: Inst, pos: InstPosition) -> InstRef

Add an instruction to the body.

pub fn move_inst(&mut self, inst: InstRef, pos: InstPosition)

Move an instruction around within the body.

pub fn remove_inst(&mut self, inst: InstRef)

Remove an instruction from the body.

pub fn inst(&self, inst: InstRef) -> &Inst

Get a reference to an instruction in the body. Panics if the instruction does not exist.

pub fn inst_mut(&mut self, inst: InstRef) -> &mut Inst

Get a mutable reference to an instruction in the body. Panics if the instruction does not exist.

Important traits for IndirectMapIter<'tf, T, V>

impl<'tf, T: Iterator + 'tf, V> Iterator for IndirectMapIter<'tf, T, V> type Item = &'tf V;

pub fn insts(&self) -> IndirectMapIter<Iter<InstRef>, Inst>

Obtain an iterator over the instructions in this entity.

pub fn inst_refs(&self) -> Iter<InstRef>

Obtain an iterator over references to the instructions in this entity.

Trait Implementations

impl Value for Entity

fn id(&self) -> ValueId

Get the unique ID of the value.

fn ty(&self) -> Type

Get the type of the value.

fn name(&self) -> Option<&str>

Get the optional name of the value.

fn is_global(&self) -> bool

Whether this value is global or not. Global values are considered during linking, and are visible in a module's symbol table. Local values are not, and are only visible within the surrounding context (module or unit).