Struct kcl_lib::ast::types::Program

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

Fields

start: usize

end: usize

body: Vec<BodyItem>

non_code_meta: NonCodeMeta

digest: Option<Digest>

Implementations

impl Program

pub fn compute_digest(&mut self) -> Digest

Compute a digest over the AST node.

pub fn get_hover_value_for_position( &self, pos: usize, code: &str, ) -> Option<Hover>

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

pub fn lint<'a, RuleT>(&'a self, rule: RuleT) -> Result<Vec<Discovered>>

where RuleT: Rule<'a>,

Check the provided Program for any lint findings.

pub fn lint_all(&self) -> Result<Vec<Discovered>>

pub fn completion_items<'a>(&'a self) -> Result<Vec<CompletionItem>>

Walk the ast and get all the variables and tags as completion items.

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<&Expr>

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

pub fn get_non_code_meta_for_position(&self, pos: usize) -> Option<&NonCodeMeta>

Returns a non code meta that includes the given character position.

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

Returns all the lsp symbols in the program.

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

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: 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<&VariableDeclarator>

Get the variable declaration with the given name.

Trait Implementations

impl Bake for Program

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

Returns a TokenStream that would evaluate to self.

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 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<'a> From<&'a Program> for Node<'a>

fn from(v: &'a Program) -> Self

Converts to this type from the input type.

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

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

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

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.

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<&'static Path>

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.

const DOCS: Option<&'static str> = None

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