Enum KclValueView 

pub enum KclValueView {
    Uuid {
        value: Uuid,
    },
    Bool {
        value: bool,
    },
    Number {
        value: f64,
        ty: NumericType,
    },
    String {
        value: String,
    },
    Enum {
        enum_name: String,
        variant: String,
    },
    SketchVar {
        value: Box<SketchVarView>,
    },
    SketchConstraint {
        value: Value,
    },
    Tuple {
        value: Vec<KclValueView>,
    },
    HomArray {
        value: Vec<KclValueView>,
    },
    Object {
        value: IndexMap<String, KclValueView>,
        constrainable: bool,
    },
    TagIdentifier {
        value: String,
    },
    TagDeclarator {
        value: String,
    },
    GdtAnnotation {
        value: Box<GdtAnnotationView>,
    },
    CameraView {
        value: Value,
    },
    NamedView {
        value: Value,
    },
    Plane {
        value: Box<PlaneView>,
    },
    Face {
        value: Box<FaceView>,
    },
    BoundedEdge {
        value: BoundedEdgeView,
    },
    Segment {
        value: Value,
    },
    Sketch {
        value: Box<SketchView>,
    },
    Solid {
        value: Box<SolidView>,
    },
    Helix {
        value: Box<HelixView>,
    },
    ImportedGeometry(ImportedGeometryView),
    Function {},
    Module {
        value: ModuleId,
    },
    Type {
        experimental: bool,
    },
    KclNone {},
}

A serializable, presentational view of any KCL value.

This type deliberately contains no executor state. Runtime values are converted to it by kcl-lib before they cross an API boundary.

Variants

Uuid

Fields

value: Uuid

Bool

Fields

value: bool

Number

Fields

value: f64

ty: NumericType

String

Fields

value: String

Enum

Exposed by nominal identity, not by the variant’s representation.

Fields

enum_name: String

variant: String

SketchVar

Fields

value: Box<SketchVarView>

SketchConstraint

Sketch constraints are currently only shown in the debug memory pane.

Fields

value: Value

Tuple

Fields

value: Vec<KclValueView>

HomArray

An array where all values have a shared type.

Fields

value: Vec<KclValueView>

Object

Fields

value: IndexMap<String, KclValueView>

constrainable: bool

TagIdentifier

Fields

value: String

TagDeclarator

Fields

value: String

GdtAnnotation

Fields

value: Box<GdtAnnotationView>

CameraView

Camera values are currently only shown in the debug memory pane.

Fields

value: Value

NamedView

Named views are consumed through the artifact graph, not program memory.

Fields

value: Value

Plane

Fields

value: Box<PlaneView>

Face

Fields

value: Box<FaceView>

BoundedEdge

Fields

value: BoundedEdgeView

Segment

Standalone segments are currently only shown in the debug memory pane.

Fields

value: Value

Sketch

Fields

value: Box<SketchView>

Solid

Fields

value: Box<SolidView>

Helix

Fields

value: Box<HelixView>

ImportedGeometry(ImportedGeometryView)

Function

Module

Fields

value: ModuleId

Type

Fields

experimental: bool

KclNone

Trait Implementations

impl Clone for KclValueView

fn clone(&self) -> KclValueView

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KclValueView

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KclValueView

fn deserialize<__D>( __deserializer: __D, ) -> Result<KclValueView, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<KclValue> for KclValueView

fn from(full: KclValue) -> Self

Converts to this type from the input type.

impl JsonSchema for KclValueView

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(generator: &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 KclValueView

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for KclValueView

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for KclValueView

impl TS for KclValueView

type WithoutGenerics = KclValueView

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 = KclValueView

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 KclValueView: '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 KclValueView: '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.