Enum kcl_lib::ast::types::NonCodeValue

pub enum NonCodeValue {
    InlineComment {
        value: String,
        style: CommentStyle,
    },
    BlockComment {
        value: String,
        style: CommentStyle,
    },
    NewLineBlockComment {
        value: String,
        style: CommentStyle,
    },
    NewLine,
}

Variants

InlineComment

Fields

value: String

style: CommentStyle

An inline comment. Here are examples: 1 + 1 // This is an inline comment. 1 + 1 /* Here's another */.

BlockComment

Fields

value: String

style: CommentStyle

A block comment. An example of this is the following:

/* This is a
    block comment */
1 + 1

Now this is important. The block comment is attached to the next line. This is always the case. Also the block comment doesn’t have a new line above it. If it did it would be a NewLineBlockComment.

NewLineBlockComment

Fields

value: String

style: CommentStyle

A block comment that has a new line above it. The user explicitly added a new line above the block comment.

NewLine

Trait Implementations

impl Bake for NonCodeValue

fn bake(&self, env: &CrateEnv) -> TokenStream

Returns a TokenStream that would evaluate to self.

impl Clone for NonCodeValue

fn clone(&self) -> NonCodeValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NonCodeValue

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NonCodeValue

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for NonCodeValue

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 NonCodeValue

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

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 NonCodeValue

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

impl StructuralPartialEq for NonCodeValue