Struct calyx_ir::LibrarySignatures

pub struct LibrarySignatures { /* private fields */ }

A representation of all the primitive definitions found while parsing the root program.

Implementations

impl LibrarySignatures

pub fn add_inline_primitive(
    &mut self,
    primitive: Primitive
) -> &mut PrimitiveInfo

Add a new inline primitive to the context. Panics if a primitive with the same name is already defined.

pub fn add_extern_primitive(&mut self, file: PathBuf, primitive: Primitive)

Add a new, non-inline primitive to the context. Panics if a primitive with the same name is already defined. Requires that the file path is absolute and canonical.

pub fn find_primitive<S>(&self, name: S) -> Option<&Primitive>where
    S: Into<Id>,

Return the Primitive associated with the given name if defined, otherwise return None.

pub fn get_primitive<S>(&self, name: S) -> &Primitivewhere
    S: Into<Id>,

Return the Primitive associated to this Id.

pub fn mark_inline_source(&mut self, name: Id)

Mark an inlined primitive as a part of the source. This is useful when using file mode compilation and printing only the source primitives. Panics if the primitive is not defined.

pub fn mark_extern_source(&mut self, path: PathBuf)

Marks an imported extern block as a part of the source. There is no way to mark an individual primitive as a part of the source since the entire file will be linked. Panics if the file path is not defined

pub fn signatures(&self) -> impl Iterator<Item = &Primitive>

Return an iterator over all defined primitives.

pub fn prim_infos(&self) -> &Vec<PrimitiveInfo, Global>

Returns all the underlying primitive information. If you want all the signatures, use LibrarySignatures::signatures instead.

pub fn prim_inlines(&self) -> impl Iterator<Item = (&Primitive, bool)>

Return the underyling inlined primitives and whether they are source defined

pub fn extern_paths(&self) -> Vec<&PathBuf, Global>

Return the paths for the extern defining files along with whether they are source defined.

Trait Implementations

impl Debug for LibrarySignatures

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

Formats the value using the given formatter.

impl Default for LibrarySignatures

fn default() -> LibrarySignatures

Returns the “default value” for a type.