Struct ExecOutcome 

pub struct ExecOutcome {
    pub variables: IndexMap<String, KclValue>,
    pub operations: Vec<Operation>,
    pub artifact_graph: ArtifactGraph,
    pub scene_objects: Vec<Object>,
    pub source_range_to_object: BTreeMap<SourceRange, ObjectId>,
    pub var_solutions: Vec<(SourceRange, Number)>,
    pub issues: Vec<CompilationIssue>,
    pub filenames: IndexMap<ModuleId, ModulePath>,
    pub default_planes: Option<DefaultPlanes>,
}

Outcome of executing a program. This is used in TS.

Fields

variables: IndexMap<String, KclValue>

Variables in the top-level of the root module. Note that functions will have an invalid env ref.

operations: Vec<Operation>

Operations that have been performed in execution order, for display in the Feature Tree.

artifact_graph: ArtifactGraph

Output artifact graph.

scene_objects: Vec<Object>

Objects in the scene, created from execution.

source_range_to_object: BTreeMap<SourceRange, ObjectId>

Map from source range to object ID for lookup of objects by their source range.

var_solutions: Vec<(SourceRange, Number)>

issues: Vec<CompilationIssue>

Non-fatal errors and warnings.

filenames: IndexMap<ModuleId, ModulePath>

File Names in module Id array index order

default_planes: Option<DefaultPlanes>

The default planes.

Implementations

impl ExecOutcome

pub fn scene_object_by_id(&self, id: ObjectId) -> Option<&Object>

pub fn errors(&self) -> impl Iterator<Item = &CompilationIssue>

Returns non-fatal errors. Warnings are not included.

pub fn sketch_constraint_report(&self) -> SketchConstraintReport

Analyze all sketches in the execution result and group them by constraint status (fully, under, or over constrained).

Each segment in a sketch computes its own freedom by looking up the freedom of its constituent points. Owned points (belonging to a Line/Arc/Circle) are skipped to avoid double-counting.

Trait Implementations

impl Clone for ExecOutcome

fn clone(&self) -> ExecOutcome

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExecOutcome

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

Formats the value using the given formatter.

impl PartialEq for ExecOutcome

fn eq(&self, other: &ExecOutcome) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ExecOutcome

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TS for ExecOutcome

type WithoutGenerics = ExecOutcome

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or ().
The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = ExecOutcome

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident(cfg: &Config) -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name(cfg: &Config) -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete(cfg: &Config) -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl(cfg: &Config) -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline(cfg: &Config) -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened(cfg: &Config) -> String

Flatten a type declaration. This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported, relative to the output directory. The returned path does not include any base directory.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies(cfg: &Config) -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies. To export only this type, without its dependencies, use TS::export.

fn export_to_string(cfg: &Config) -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String. This function does not format the output, even if the format feature is enabled.

impl StructuralPartialEq for ExecOutcome