Struct Context

pub struct Context {
    pub executor: Arc<dyn Executor>,
    pub cache: Cache,
    /* private fields */
}

The global context.

Stores configuration such as the PDK and tool plugins to use during generation.

Cheaply clonable.

Fields

executor: Arc<dyn Executor>

The executor to which commands should be submitted.

cache: Cache

A cache for storing the results of expensive computations.

Implementations

impl Context

pub fn new() -> Self

Creates a new Context.

impl Context

pub fn builder() -> ContextBuilder

Creates a builder for constructing a context.

pub fn generate_cross_schematic<B: Schematic, S2: FromSchema<B::Schema> + ?Sized>( &self, block: B, ) -> SchemaCellHandle<S2, B>

Generates a schematic of a block in schema S1 for use in schema S2.

Can only generate a cross schematic with one layer of FromSchema indirection.

pub fn generate_schematic<T: Schematic>( &self, block: T, ) -> SchemaCellHandle<T::Schema, T>

Generates a schematic for block in the background.

Returns a handle to the cell being generated.

pub fn export_scir<T: Schematic>( &self, block: T, ) -> Result<RawLib<T::Schema>, ConvError>

Export the given block and all sub-blocks as a SCIR library.

Returns a SCIR library and metadata for converting between SCIR and Substrate formats.

pub fn export_scir_all<S: Schema + ?Sized>( &self, cells: &[&RawCell<S>], ) -> Result<RawLib<S>, ConvError>

Export the given cells and all their subcells as a SCIR library.

Returns a SCIR library and metadata for converting between SCIR and Substrate formats.

pub fn get_sim_controller<S, T>( &self, block: T, work_dir: impl Into<PathBuf>, ) -> Result<SimController<S, T>>

where S: Simulator, T: Testbench<S>,

Returns a simulation controller for the given testbench and simulator.

pub fn install<I>(&mut self, installation: I) -> Arc<I>

where I: PrivateInstallation,

Installs the given PrivateInstallation.

Only one installation of any given type can exist. Overwrites conflicting installations of the same type.

pub fn get_or_install<I>(&self, installation: I) -> Arc<I>

where I: PrivateInstallation,

Installs the given PrivateInstallation.

Returns the existing installation if one is present.

pub fn get_private_installation<I: PrivateInstallation>(&self) -> Option<Arc<I>>

Gets a private installation from the context installation map.

pub fn get_installation<I: Installation>(&self) -> Option<Arc<I>>

Gets an installation from the context installation map.

pub fn generate_layout<T: Layout>(&self, block: T) -> LayoutCellHandle<T>

Generates a layout for block in the background.

Returns a handle to the cell being generated.

pub fn export_layir<T: Layout>( &self, block: T, ) -> Result<RawLib<<T::Schema as Schema>::Layer>>

Exports the layout of a block to a LayIR library.

pub fn export_layir_all<'a, L: Clone + 'a>( &self, cells: impl IntoIterator<Item = &'a RawCell<L>>, ) -> Result<RawLib<L>>

Writes a set of layout cells to a LayIR library.

pub fn import_layir<S: Schema>( &self, lib: Library<S::Layer>, top: CellId, ) -> Result<Arc<RawCell<S::Layer>>>

Imports a LayIR library into the context.

pub fn write_layout<B: Layout>( &self, block: B, to_gds: impl FnOnce(&Library<CellLayer<B>>) -> (Library<GdsLayer>, GdsUnits), path: impl AsRef<Path>, ) -> Result<()>

Writes a layout cell to GDS.

pub fn write_layout_all<'a, L: Clone + 'a>( &self, cells: impl IntoIterator<Item = &'a RawCell<L>>, to_gds: impl FnOnce(&Library<L>) -> (Library<GdsLayer>, GdsUnits), path: impl AsRef<Path>, ) -> Result<()>

Writes a set of layout cells to GDS.

Trait Implementations

impl Clone for Context

fn clone(&self) -> Context

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Context

fn default() -> Self

Returns the “default value” for a type.