Enum KclValue

pub enum KclValue {
    Uuid {
        value: Uuid,
        meta: Vec<Metadata>,
    },
    Bool {
        value: bool,
        meta: Vec<Metadata>,
    },
    Number {
        value: f64,
        ty: NumericType,
        meta: Vec<Metadata>,
    },
    String {
        value: String,
        meta: Vec<Metadata>,
    },
    Tuple {
        value: Vec<KclValue>,
        meta: Vec<Metadata>,
    },
    HomArray {
        value: Vec<KclValue>,
        ty: RuntimeType,
    },
    Object {
        value: HashMap<String, KclValue>,
        meta: Vec<Metadata>,
    },
    TagIdentifier(Box<TagIdentifier>),
    TagDeclarator(Box<Node<TagDeclarator>>),
    Plane {
        value: Box<Plane>,
    },
    Face {
        value: Box<Face>,
    },
    Sketch {
        value: Box<Sketch>,
    },
    Solid {
        value: Box<Solid>,
    },
    Helix {
        value: Box<Helix>,
    },
    ImportedGeometry(ImportedGeometry),
    Function {
        value: FunctionSource,
        meta: Vec<Metadata>,
    },
    Module {
        value: ModuleId,
        meta: Vec<Metadata>,
    },
    Type {
        value: TypeDef,
        meta: Vec<Metadata>,
    },
    KclNone {
        value: KclNone,
        meta: Vec<Metadata>,
    },
}

Any KCL value.

Variants

Uuid

Fields

value: Uuid

meta: Vec<Metadata>

Bool

Fields

value: bool

meta: Vec<Metadata>

Number

Fields

value: f64

ty: NumericType

meta: Vec<Metadata>

String

Fields

value: String

meta: Vec<Metadata>

Tuple

Fields

value: Vec<KclValue>

meta: Vec<Metadata>

HomArray

Fields

value: Vec<KclValue>

ty: RuntimeType

Object

Fields

value: HashMap<String, KclValue>

meta: Vec<Metadata>

TagIdentifier(Box<TagIdentifier>)

TagDeclarator(Box<Node<TagDeclarator>>)

Plane

Fields

value: Box<Plane>

Face

Fields

value: Box<Face>

Sketch

Fields

value: Box<Sketch>

Solid

Fields

value: Box<Solid>

Helix

Fields

value: Box<Helix>

ImportedGeometry(ImportedGeometry)

Function

Fields

value: FunctionSource

meta: Vec<Metadata>

Module

Fields

value: ModuleId

meta: Vec<Metadata>

Type

Fields

value: TypeDef

meta: Vec<Metadata>

KclNone

Fields

value: KclNone

meta: Vec<Metadata>

Implementations

impl KclValue

pub const fn from_number_with_type( f: f64, ty: NumericType, meta: Vec<Metadata>, ) -> Self

pub fn from_point2d(p: [f64; 2], ty: NumericType, meta: Vec<Metadata>) -> Self

Put the point into a KCL value.

pub fn as_int(&self) -> Option<i64>

pub fn as_int_with_ty(&self) -> Option<(i64, NumericType)>

pub fn as_object(&self) -> Option<&HashMap<String, KclValue>>

pub fn into_object(self) -> Option<HashMap<String, KclValue>>

pub fn as_str(&self) -> Option<&str>

pub fn as_array(&self) -> Option<&[KclValue]>

pub fn as_point2d(&self) -> Option<[TyF64; 2]>

pub fn as_point3d(&self) -> Option<[TyF64; 3]>

pub fn as_uuid(&self) -> Option<Uuid>

pub fn as_plane(&self) -> Option<&Plane>

pub fn as_solid(&self) -> Option<&Solid>

pub fn as_sketch(&self) -> Option<&Sketch>

pub fn as_mut_sketch(&mut self) -> Option<&mut Sketch>

pub fn as_mut_tag(&mut self) -> Option<&mut TagIdentifier>

pub fn as_ty_f64(&self) -> Option<TyF64>

pub fn as_bool(&self) -> Option<bool>

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

If this value fits in a u32, return it.

pub fn get_function(&self) -> Option<&FunctionSource>

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<Node<TagDeclarator>, KclError>

Get a tag declarator from a memory item.

pub fn get_bool(&self) -> Result<bool, KclError>

If this KCL value is a bool, retrieve it.

pub fn as_fn(&self) -> Option<&FunctionSource>

pub fn value_str(&self) -> Option<String>

impl KclValue

pub fn has_type(&self, ty: &RuntimeType) -> bool

True if self has a type which is a subtype of ty without coercion.

pub fn coerce( &self, ty: &RuntimeType, exec_state: &mut ExecState, ) -> Result<KclValue, CoercionError>

Coerce self to a new value which has ty as its closest supertype.

If the result is Ok, then:

• result.principal_type().unwrap().subtype(ty)

If self.principal_type() == ty then result == self

pub fn principal_type(&self) -> Option<RuntimeType>

Trait Implementations

impl Clone for KclValue

fn clone(&self) -> KclValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KclValue

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

Formats the value using the given formatter.

impl From<&Box<Node<TagDeclarator>>> for KclValue

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

Converts to this type from the input type.

impl From<&KclValue> for SourceRange

fn from(item: &KclValue) -> Self

Converts to this type from the input type.

impl From<&KclValue> for Vec<SourceRange>

fn from(item: &KclValue) -> Self

Converts to this type from the input type.

impl From<KclValue> for Vec<SourceRange>

fn from(item: KclValue) -> Self

Converts to this type from the input type.

impl From<Vec<Sketch>> for KclValue

fn from(eg: Vec<Sketch>) -> Self

Converts to this type from the input type.

impl From<Vec<Solid>> for KclValue

fn from(eg: Vec<Solid>) -> Self

Converts to this type from the input type.

impl<'a> FromKclValue<'a> for KclValue

fn from_kcl_val(arg: &'a KclValue) -> Option<Self>

Try to convert a KclValue into this type.

impl JsonSchema for KclValue

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 KclValue

fn eq(&self, other: &KclValue) -> 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 KclValue

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 KclValue

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

type WithoutGenerics = KclValue

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.

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 KclValue