Enum KclError

pub enum KclError {
    Lexical {
        details: KclErrorDetails,
    },
    Syntax {
        details: KclErrorDetails,
    },
    Semantic {
        details: KclErrorDetails,
    },
    ImportCycle {
        details: KclErrorDetails,
    },
    Type {
        details: KclErrorDetails,
    },
    Io {
        details: KclErrorDetails,
    },
    Unexpected {
        details: KclErrorDetails,
    },
    ValueAlreadyDefined {
        details: KclErrorDetails,
    },
    UndefinedValue {
        details: KclErrorDetails,
        name: Option<String>,
    },
    InvalidExpression {
        details: KclErrorDetails,
    },
    Engine {
        details: KclErrorDetails,
    },
    Internal {
        details: KclErrorDetails,
    },
}

Variants

Lexical

Fields

details: KclErrorDetails

Syntax

Fields

details: KclErrorDetails

Semantic

Fields

details: KclErrorDetails

ImportCycle

Fields

details: KclErrorDetails

Type

Fields

details: KclErrorDetails

Io

Fields

details: KclErrorDetails

Unexpected

Fields

details: KclErrorDetails

ValueAlreadyDefined

Fields

details: KclErrorDetails

UndefinedValue

Fields

details: KclErrorDetails

name: Option<String>

InvalidExpression

Fields

details: KclErrorDetails

Engine

Fields

details: KclErrorDetails

Internal

Fields

details: KclErrorDetails

Implementations

impl KclError

pub fn internal(message: String) -> KclError

pub fn new_internal(details: KclErrorDetails) -> KclError

pub fn new_import_cycle(details: KclErrorDetails) -> KclError

pub fn new_semantic(details: KclErrorDetails) -> KclError

pub fn new_value_already_defined(details: KclErrorDetails) -> KclError

pub fn new_syntax(details: KclErrorDetails) -> KclError

pub fn new_io(details: KclErrorDetails) -> KclError

pub fn new_engine(details: KclErrorDetails) -> KclError

pub fn new_lexical(details: KclErrorDetails) -> KclError

pub fn new_undefined_value( details: KclErrorDetails, name: Option<String>, ) -> KclError

pub fn new_type(details: KclErrorDetails) -> KclError

pub fn get_message(&self) -> String

Get the error message.

pub fn error_type(&self) -> &'static str

pub fn source_ranges(&self) -> Vec<SourceRange>

pub fn message(&self) -> &str

Get the inner error message.

pub fn backtrace(&self) -> Vec<BacktraceItem>

Trait Implementations

impl Clone for KclError

fn clone(&self) -> KclError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KclError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KclError

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for KclError

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

Formats the value using the given formatter.

impl Error for KclError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<KclError> for String

This is different than to_string() in that it will serialize the Error the struct as JSON so we can deserialize it on the js side.

fn from(error: KclError) -> Self

Converts to this type from the input type.

impl From<KclErrorWithOutputs> for KclError

fn from(error: KclErrorWithOutputs) -> Self

Converts to this type from the input type.

impl From<ParseError<Stateful<LocatingSlice<&str>, State>, ContextError>> for KclError

fn from( err: ParseError<Stateful<LocatingSlice<&'_ str>, State>, ContextError>, ) -> Self

Converts to this type from the input type.

impl From<String> for KclError

fn from(error: String) -> Self

Converts to this type from the input type.

impl PartialEq for KclError

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

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

const 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 KclError

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 KclError

type WithoutGenerics = KclError

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

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

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 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 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 Eq for KclError

impl StructuralPartialEq for KclError