Struct kcl_lib::ast::types::Program

pub struct Program {
    pub start: usize,
    pub end: usize,
    pub body: Vec<BodyItem>,
    pub non_code_meta: NonCodeMeta,
}

Fields

start: usize

end: usize

body: Vec<BodyItem>

non_code_meta: NonCodeMeta

Implementations

impl Program

pub fn recast( &self, options: &FormatOptions, indentation_level: usize ) -> String

pub fn get_body_item_for_position(&self, pos: usize) -> Option<&BodyItem>

Returns the body item that includes the given character position.

pub fn get_mut_body_item_for_position( &mut self, pos: usize ) -> Option<&mut BodyItem>

Returns the body item that includes the given character position.

pub fn get_value_for_position(&self, pos: usize) -> Option<&Value>

Returns a value that includes the given character position. This is a bit more recursive than get_body_item_for_position.

pub fn get_lsp_symbols(&self, code: &str) -> Vec<DocumentSymbol>

Returns all the lsp symbols in the program.

pub fn rename_symbol(&mut self, new_name: &str, pos: usize)

Rename the variable declaration at the given position.

pub fn replace_variable(&mut self, name: &str, declarator: VariableDeclarator)

Replace a variable declaration with the given name with a new one.

pub fn replace_value(&mut self, source_range: SourceRange, new_value: Value)

Replace a value with the new value, use the source range for matching the exact value.

pub fn get_variable(&self, name: &str) -> Option<&VariableDeclarator>

Get the variable declaration with the given name.

Trait Implementations

impl Clone for Program

fn clone(&self) -> Program

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Program

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Program

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

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Program

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 Program

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

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 Program

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 inline_flattened() -> String

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

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