Enum kcl_lib::errors::KclError

pub enum KclError {
    Syntax(KclErrorDetails),
    Semantic(KclErrorDetails),
    Type(KclErrorDetails),
    Unimplemented(KclErrorDetails),
    Unexpected(KclErrorDetails),
    ValueAlreadyDefined(KclErrorDetails),
    UndefinedValue(KclErrorDetails),
    InvalidExpression(KclErrorDetails),
    Engine(KclErrorDetails),
}

Variants

Syntax(KclErrorDetails)

Semantic(KclErrorDetails)

Type(KclErrorDetails)

Unimplemented(KclErrorDetails)

Unexpected(KclErrorDetails)

ValueAlreadyDefined(KclErrorDetails)

UndefinedValue(KclErrorDetails)

InvalidExpression(KclErrorDetails)

Engine(KclErrorDetails)

Implementations

impl KclError

pub fn get_message_line_column( &self, input: &str ) -> (String, Option<usize>, Option<usize>)

Get the error message, line and column from the error and input code.

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

pub fn to_lsp_diagnostic(&self, code: &str) -> Diagnostic

Trait Implementations

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

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

fn from(error: String) -> Self

Converts to this type from the input type.

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

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

fn decl() -> String

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

fn name() -> String

Name of this type in TypeScript.

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 dependencies() -> Vec<Dependency>where Self: 'static,

Information about types this type depends on. This is used for resolving imports when exporting to a file.

fn transparent() -> bool

true if this is a transparent type, e.g tuples or a list. This is used for resolving imports when using the export! macro.

fn name_with_type_args(args: Vec<String, Global>) -> String

Name of this type in TypeScript, with type arguments.

fn inline_flattened() -> String

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

fn export() -> Result<(), ExportError>where Self: 'static,

Manually export this type to a file. The output file can be specified by annotating the type with #[ts(export_to = ".."]. By default, the filename will be derived from the types name.

fn export_to(path: impl AsRef<Path>) -> Result<(), ExportError>where Self: 'static,

Manually export this type to a file with a file with the specified path. This function will ignore the #[ts(export_to = "..)] attribute.

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.