Struct AstProgram 

pub struct AstProgram {
    pub body: Vec<BodyItem>,
    pub non_code_meta: NonCodeMeta,
    pub shebang: Option<Node<Shebang>>,
    pub inner_attrs: NodeList<Annotation>,
    pub digest: Option<[u8; 32]>,
}

A KCL program top level, or function body.

Fields

body: Vec<BodyItem>

non_code_meta: NonCodeMeta

shebang: Option<Node<Shebang>>

inner_attrs: NodeList<Annotation>

digest: Option<[u8; 32]>

Implementations

impl Program

pub fn ends_with_expr(&self) -> bool

Is the last body item an expression?

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_expr_for_position(&self, pos: usize) -> Option<&Expr>

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

pub fn has_import_statements(&self) -> bool

Checks if the ast has any import statements.

pub fn in_comment(&self, pos: usize) -> bool

pub fn get_lsp_folding_ranges(&self) -> Vec<FoldingRange>

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

Rename the variable declaration at the given position.

Returns whether anything was actually renamed. Only top-level declarations, import aliases, and parameters of top-level functions are supported; a position inside a nested declaration (e.g. a local in a function body or an if-expression arm) renames nothing and returns false.

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

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

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

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

pub fn get_variable(&self, name: &str) -> Option<Definition<'_>>

Get the variable declaration with the given name.

impl Program

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

pub fn recast( &self, buf: &mut String, options: &FormatOptions, indentation_level: usize, )

Trait Implementations

impl Clone for Program

fn clone(&self) -> Program

Returns a duplicate 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 Default for Program

fn default() -> Program

Returns the “default value” for a type.

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

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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

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

impl TS for Program

type WithoutGenerics = Program

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

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(cfg: &Config) -> String

Identifier of this type, excluding generic parameters.

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 name(cfg: &Config) -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete(cfg: &Config) -> 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(cfg: &Config) -> String

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

fn inline(cfg: &Config) -> 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(cfg: &Config) -> 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, relative to the output directory. The returned path does not include any base directory.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies(cfg: &Config) -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export(cfg: &Config) -> 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(cfg: &Config) -> 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_to_string(cfg: &Config) -> 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.