Enum kcl_lib::executor::MemoryItem

pub enum MemoryItem {
    UserVal(UserVal),
    TagIdentifier(Box<TagIdentifier>),
    TagDeclarator(Box<TagDeclarator>),
    Plane(Box<Plane>),
    Face(Box<Face>),
    SketchGroup(Box<SketchGroup>),
    SketchGroups {
        value: Vec<Box<SketchGroup>>,
    },
    ExtrudeGroup(Box<ExtrudeGroup>),
    ExtrudeGroups {
        value: Vec<Box<ExtrudeGroup>>,
    },
    ImportedGeometry(ImportedGeometry),
    Function {
        func: Option<MemoryFunction>,
        expression: Box<FunctionExpression>,
        memory: Box<ProgramMemory>,
        meta: Vec<Metadata>,
    },
}

A memory item.

Variants

UserVal(UserVal)

TagIdentifier(Box<TagIdentifier>)

TagDeclarator(Box<TagDeclarator>)

Plane(Box<Plane>)

Face(Box<Face>)

SketchGroup(Box<SketchGroup>)

SketchGroups

Fields

value: Vec<Box<SketchGroup>>

ExtrudeGroup(Box<ExtrudeGroup>)

ExtrudeGroups

Fields

value: Vec<Box<ExtrudeGroup>>

ImportedGeometry(ImportedGeometry)

Function

Fields

func: Option<MemoryFunction>

expression: Box<FunctionExpression>

memory: Box<ProgramMemory>

meta: Vec<Metadata>

Implementations

impl MemoryItem

pub fn get_sketch_group_set(&self) -> Result<SketchGroupSet>

pub fn get_extrude_group_set(&self) -> Result<ExtrudeGroupSet>

impl MemoryItem

pub fn get_json_value(&self) -> Result<Value, KclError>

pub fn get_json<T: DeserializeOwned>(&self) -> Result<T, KclError>

Get a JSON value and deserialize it into some concrete type.

pub fn get_json_opt<T: DeserializeOwned>(&self) -> Result<Option<T>, KclError>

Get a JSON value and deserialize it into some concrete type. If it’s a KCL None, return None. Otherwise return Some.

pub fn as_user_val(&self) -> Option<&UserVal>

pub fn get_u32(&self, source_ranges: Vec<SourceRange>) -> Result<u32, KclError>

If this value is of type u32, return it.

pub fn get_function(&self) -> Option<FnAsArg<'_>>

If this value is of type function, return it.

pub fn get_tag_identifier(&self) -> Result<TagIdentifier, KclError>

Get a tag identifier from a memory item.

pub fn get_tag_declarator(&self) -> Result<TagDeclarator, KclError>

Get a tag declarator from a memory item.

pub fn get_tag_declarator_opt(&self) -> Result<Option<TagDeclarator>, KclError>

Get an optional tag from a memory item.

pub async fn call_fn( &self, args: Vec<MemoryItem>, ctx: ExecutorContext, ) -> Result<Option<ProgramReturn>, KclError>

If this memory item is a function, call it with the given arguments, return its val as Ok. If it’s not a function, return Err.

Trait Implementations

impl Clone for MemoryItem

fn clone(&self) -> MemoryItem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MemoryItem

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MemoryItem

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Box<Literal>> for MemoryItem

fn from(literal: &Box<Literal>) -> Self

Converts to this type from the input type.

impl From<&Box<TagDeclarator>> for MemoryItem

fn from(tag: &Box<TagDeclarator>) -> Self

Converts to this type from the input type.

impl From<&KclNone> for MemoryItem

fn from(none: &KclNone) -> Self

Converts to this type from the input type.

impl From<&TagDeclarator> for MemoryItem

fn from(tag: &TagDeclarator) -> Self

Converts to this type from the input type.

impl From<ExtrudeGroupSet> for MemoryItem

fn from(eg: ExtrudeGroupSet) -> Self

Converts to this type from the input type.

impl From<Literal> for MemoryItem

fn from(literal: Literal) -> Self

Converts to this type from the input type.

impl From<MemoryItem> for Vec<SourceRange>

fn from(item: MemoryItem) -> Self

Converts to this type from the input type.

impl From<SketchGroupSet> for MemoryItem

fn from(sg: SketchGroupSet) -> Self

Converts to this type from the input type.

impl From<Vec<Box<ExtrudeGroup>>> for MemoryItem

fn from(eg: Vec<Box<ExtrudeGroup>>) -> Self

Converts to this type from the input type.

impl From<Vec<Box<SketchGroup>>> for MemoryItem

fn from(sg: Vec<Box<SketchGroup>>) -> Self

Converts to this type from the input type.

impl JsonSchema for MemoryItem

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for MemoryItem

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for MemoryItem

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 MemoryItem

type WithoutGenerics = MemoryItem

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.

fn ident() -> String

Identifier of this type, excluding generic parameters.

const DOCS: Option<&'static str> = _

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() -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete() -> 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() -> String

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

fn inline() -> 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() -> 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<&'static Path>

Returns the output path to where T should be exported.
The returned path does not include the base directory from TS_RS_EXPORT_DIR.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies() -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export() -> 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() -> 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_all_to(out_dir: impl AsRef<Path>) -> Result<(), ExportError>

where Self: 'static,

Manually export this type into the given directory, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_to_string() -> 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.

fn default_output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.

impl StructuralPartialEq for MemoryItem