Struct scir::LibraryBuilder

pub struct LibraryBuilder<S: Schema + ?Sized = NoSchema> { /* private fields */ }

A library of SCIR cells with schema S.

Implementations

impl<S: Schema + ?Sized> LibraryBuilder<S>

pub fn merge(&mut self, other: Self) -> MergedMapping

Merges another SCIR library into the current library.

pub fn merge_cells( &mut self, other: Self, cells: impl IntoIterator<Item = CellId> ) -> MergedMapping

Merges the given cells from another SCIR library into the current library.

impl<S: Schema + ?Sized> LibraryBuilder<S>

pub fn validate_drivers(&self) -> IssueSet<DriverIssue>

Perform driver analysis on this library.

impl<S: Schema + ?Sized> LibraryBuilder<S>

pub fn validate(&self) -> IssueSet<ValidatorIssue>

Check whether this library is valid.

impl<S: Schema + ?Sized> LibraryBuilder<S>

pub fn new() -> Self

Creates a new, empty library.

pub fn add_cell(&mut self, cell: Cell) -> CellId

Adds the given cell to the library.

Returns the ID of the newly added cell.

pub fn merge_cell(&mut self, cell: Cell) -> CellId

Merges the given cell into the library.

Returns the ID of the newly added cell. May rename the cell if the name is already taken.

pub fn add_primitive(&mut self, primitive: S::Primitive) -> PrimitiveId

Adds the given primitive to the library.

Returns the ID of the newly added primitive.

pub fn set_top(&mut self, cell: CellId)

Sets the top cell to the given cell ID.

pub fn top_cell(&self) -> Option<CellId>

The ID of the top-level cell, if there is one.

pub fn is_top(&self, cell: CellId) -> bool

Returns true if the given cell is the top cell.

pub fn cell(&self, id: CellId) -> &Cell

Gets the cell with the given ID.

Panics

Panics if no cell has the given ID. For a non-panicking alternative, see try_cell.

pub fn try_cell(&self, id: CellId) -> Option<&Cell>

Gets the cell with the given ID.

pub fn cell_named(&self, name: &str) -> &Cell

Gets the cell with the given name.

Panics

Panics if no cell has the given name.

pub fn try_cell_named(&self, name: &str) -> Option<&Cell>

Gets the cell with the given name.

pub fn cell_id_named(&self, name: &str) -> CellId

Gets the cell ID corresponding to the given name.

Panics

Panics if no cell has the given name. For a non-panicking alternative, see try_cell_id_named.

pub fn try_cell_id_named(&self, name: &str) -> Option<CellId>

Gets the cell ID corresponding to the given name.

pub fn cells(&self) -> impl Iterator<Item = (CellId, &Cell)>

Iterates over the (id, cell) pairs in this library.

pub fn primitive(&self, id: PrimitiveId) -> &S::Primitive

Gets the primitive with the given ID.

Panics

Panics if no primitive has the given ID. For a non-panicking alternative, see try_primitive.

pub fn try_primitive(&self, id: PrimitiveId) -> Option<&S::Primitive>

Gets the primitive with the given ID.

pub fn primitives(&self) -> impl Iterator<Item = (PrimitiveId, &S::Primitive)>

Iterates over the (id, primitive) pairs in this library.

pub fn annotate_instance_path( &self, path: InstancePath ) -> AnnotatedInstancePath

Annotates an InstancePath with additional metadata.

Finds cell IDs associated with instances in the path if they are in the SCIR library, and converts the top of the path to a cell ID if possible.

pub fn convert_annotated_instance_path( &self, conv: Option<&NetlistLibConversion>, path: AnnotatedInstancePath ) -> NamedPath

Annotates an instance path with additional metadata, such as whether each instance in the path corresponds to an actual SCIR instance.

pub fn convert_instance_path(&self, path: InstancePath) -> NamedPath

Converts an InstancePath to a NamedPath.

Panics

Panics if the path contains instance or cell IDs that do not exist.

pub fn convert_instance_path_with_conv( &self, conv: &NetlistLibConversion, path: InstancePath ) -> NamedPath

Converts an InstancePath to a NamedPath, using the provided conv to modify instance names that were converted during netlisting.

Panics

Panics if the path contains instance or cell IDs that do not exist.

pub fn convert_slice_one_path( &self, path: SliceOnePath, index_fmt: impl FnOnce(&ArcStr, Option<usize>) -> ArcStr ) -> NamedPath

Converts a SliceOnePath to a NamedPath. to modify instance names that were converted during netlisting.

Panics

Panics if the path contains instance or cell IDs that do not exist.

pub fn convert_slice_one_path_with_conv( &self, conv: &NetlistLibConversion, path: SliceOnePath, index_fmt: impl FnOnce(&ArcStr, Option<usize>) -> ArcStr ) -> NamedPath

Converts a SliceOnePath to a NamedPath, using the provided conv to modify instance names that were converted during netlisting.

Panics

Panics if the path contains instance or cell IDs that do not exist.

pub fn simplify_path(&self, path: SliceOnePath) -> SliceOnePath

Returns a simplified path to the provided node, bubbling up through IOs.

Panics

Panics if the provided path does not exist within the SCIR library.

pub fn build(self) -> Result<Library<S>, Issues>

Validate and construct a SCIR Library.

If errors are encountered during validation, returns an Err(_) containing the set of issues found. If no errors are encountered, returns an Ok(_) containing the SCIR library. Warnings and infos are discarded.

If you want to inspect warnings/infos, consider using try_build instead.

pub fn try_build(self) -> Result<(Library<S>, Issues), Issues>

Validate and construct a SCIR Library.

If errors are encountered during validation, returns an Err(_) containing the set of issues found. If no errors are encountered, returns Ok((library, issues)). The issues returned will not have any errors, but may have warnings or infos.

If you do not want to inspect warnings/infos, consider using build instead.

pub fn drop_schema(self) -> Result<LibraryBuilder<NoSchema>, NoSchemaError>

Converts a LibraryBuilder<S> to a LibraryBuilder<NoSchema>, throwing an error if there are any primitives.

pub fn convert_schema<C>(self) -> Result<LibraryBuilder<C>, C::Error>

where C: FromSchema<S> + Schema + ?Sized,

Converts a LibraryBuilder<S> into a LibraryBuilder<C>.

Instances associated with non-existent primitives will remain unchanged.

impl<S: Schema<Primitive = impl Clone> + ?Sized> LibraryBuilder<S>

pub fn from_cell_named(lib: &Self, cell: &str) -> Self

Creates a new SCIR library builder containing only the named cell and its children from an existing library builder.

Trait Implementations

impl<S: Schema<Primitive = impl Clone> + ?Sized> Clone for LibraryBuilder<S>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Schema<Primitive = impl Debug> + ?Sized> Debug for LibraryBuilder<S>

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

Formats the value using the given formatter.

impl<S: Schema + ?Sized> Default for LibraryBuilder<S>

fn default() -> Self

Returns the “default value” for a type.