Struct Node

pub struct Node<T> {
    pub inner: T,
    pub start: usize,
    pub end: usize,
    pub module_id: ModuleId,
}

Fields

inner: T

start: usize

end: usize

module_id: ModuleId

Implementations

impl Node<IfExpression>

pub fn get_constraint_level(&self) -> ConstraintLevel

Get the constraint level.

impl Node<MemberExpression>

pub fn get_result_array( &self, exec_state: &mut ExecState, index: usize, ) -> Result<KclValue, KclError>

pub fn get_result( &self, exec_state: &mut ExecState, ) -> Result<KclValue, KclError>

impl Node<BinaryExpression>

pub fn get_result<'life0, 'life1, 'life_self, 'async_recursion>( &'life_self self, exec_state: &'life0 mut ExecState, ctx: &'life1 ExecutorContext, ) -> Pin<Box<dyn Future<Output = Result<KclValue, KclError>> + Send + 'async_recursion>>

where 'life0: 'async_recursion, 'life1: 'async_recursion, 'life_self: 'async_recursion,

impl Node<UnaryExpression>

pub async fn get_result( &self, exec_state: &mut ExecState, ctx: &ExecutorContext, ) -> Result<KclValue, KclError>

impl Node<CallExpression>

pub fn execute<'life0, 'life1, 'life_self, 'async_recursion>( &'life_self self, exec_state: &'life0 mut ExecState, ctx: &'life1 ExecutorContext, ) -> Pin<Box<dyn Future<Output = Result<KclValue, KclError>> + Send + 'async_recursion>>

where 'life0: 'async_recursion, 'life1: 'async_recursion, 'life_self: 'async_recursion,

impl Node<TagDeclarator>

pub async fn execute( &self, exec_state: &mut ExecState, ) -> Result<KclValue, KclError>

impl Node<ArrayExpression>

pub fn execute<'life0, 'life1, 'life_self, 'async_recursion>( &'life_self self, exec_state: &'life0 mut ExecState, ctx: &'life1 ExecutorContext, ) -> Pin<Box<dyn Future<Output = Result<KclValue, KclError>> + Send + 'async_recursion>>

where 'life0: 'async_recursion, 'life1: 'async_recursion, 'life_self: 'async_recursion,

impl Node<ArrayRangeExpression>

pub fn execute<'life0, 'life1, 'life_self, 'async_recursion>( &'life_self self, exec_state: &'life0 mut ExecState, ctx: &'life1 ExecutorContext, ) -> Pin<Box<dyn Future<Output = Result<KclValue, KclError>> + Send + 'async_recursion>>

where 'life0: 'async_recursion, 'life1: 'async_recursion, 'life_self: 'async_recursion,

impl Node<ObjectExpression>

pub fn execute<'life0, 'life1, 'life_self, 'async_recursion>( &'life_self self, exec_state: &'life0 mut ExecState, ctx: &'life1 ExecutorContext, ) -> Pin<Box<dyn Future<Output = Result<KclValue, KclError>> + Send + 'async_recursion>>

where 'life0: 'async_recursion, 'life1: 'async_recursion, 'life_self: 'async_recursion,

impl Node<IfExpression>

pub fn get_result<'life0, 'life1, 'life_self, 'async_recursion>( &'life_self self, exec_state: &'life0 mut ExecState, ctx: &'life1 ExecutorContext, ) -> Pin<Box<dyn Future<Output = Result<KclValue, KclError>> + Send + 'async_recursion>>

where 'life0: 'async_recursion, 'life1: 'async_recursion, 'life_self: 'async_recursion,

impl Node<KclNone>

pub fn get_constraint_level(&self) -> ConstraintLevel

Get the constraint level. KCL None is never constrained.

impl<T> Node<T>

pub fn new(inner: T, start: usize, end: usize, module_id: ModuleId) -> Self

pub fn no_src(inner: T) -> Self

pub fn boxed( inner: T, start: usize, end: usize, module_id: ModuleId, ) -> BoxNode<T>

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

impl Node<Program>

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_lsp_symbols<'a>(&'a self, code: &str) -> Result<Vec<DocumentSymbol>>

Returns all the lsp symbols in the program.

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

impl Node<NonCodeNode>

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

pub fn format(&self, indentation: &str) -> String

impl Node<ImportItem>

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

impl Node<ImportStatement>

pub fn get_constraint_level(&self) -> ConstraintLevel

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

impl Node<CallExpression>

pub fn get_constraint_level(&self) -> ConstraintLevel

Return the constraint level for this call expression.

impl Node<VariableDeclaration>

pub fn get_lsp_folding_range(&self) -> Option<FoldingRange>

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

Rename the variable declaration at the given position. This returns the old name of the variable, if it found one.

impl Node<Literal>

pub fn get_constraint_level(&self) -> ConstraintLevel

Get the constraint level for this literal. Literals are always not constrained.

impl Node<Identifier>

pub fn get_constraint_level(&self) -> ConstraintLevel

Get the constraint level for this identifier. Identifier are always fully constrained.

impl Node<TagDeclarator>

pub fn get_constraint_level(&self) -> ConstraintLevel

Get the constraint level for this identifier. TagDeclarator are always fully constrained.

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

impl Node<ArrayExpression>

pub fn get_constraint_level(&self) -> ConstraintLevel

impl Node<ArrayRangeExpression>

pub fn get_constraint_level(&self) -> ConstraintLevel

impl Node<ObjectExpression>

pub fn get_constraint_level(&self) -> ConstraintLevel

impl Node<ObjectProperty>

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

impl Node<MemberExpression>

pub fn get_constraint_level(&self) -> ConstraintLevel

Get the constraint level for a member expression. This is always fully constrained.

impl Node<BinaryExpression>

pub fn get_constraint_level(&self) -> ConstraintLevel

impl Node<PipeExpression>

pub fn get_constraint_level(&self) -> ConstraintLevel

pub fn get_result<'life0, 'life1, 'life_self, 'async_recursion>( &'life_self self, exec_state: &'life0 mut ExecState, ctx: &'life1 ExecutorContext, ) -> Pin<Box<dyn Future<Output = Result<KclValue, KclError>> + Send + 'async_recursion>>

where 'life0: 'async_recursion, 'life1: 'async_recursion, 'life_self: 'async_recursion,

impl Node<FunctionExpression>

pub fn get_constraint_level(&self) -> ConstraintLevel

Function expressions don’t really apply.

Trait Implementations

impl<T> Bake for Node<T>

where T: Bake,

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

Returns a TokenStream that would evaluate to self.

impl<T: Clone> Clone for Node<T>

fn clone(&self) -> Node<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Node<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Node<T>

fn default() -> Node<T>

Returns the “default value” for a type.

impl<T> DerefMut for Node<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de, T> Deserialize<'de> for Node<T>

where T: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Display> Display for Node<T>

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

Formats the value using the given formatter.

impl<'a> From<&'a Node<ArrayExpression>> for Node<'a>

fn from(v: NodeRef<'a, ArrayExpression>) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Node<ArrayRangeExpression>> for Node<'a>

fn from(v: NodeRef<'a, ArrayRangeExpression>) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Node<BinaryExpression>> for Node<'a>

fn from(v: NodeRef<'a, BinaryExpression>) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Node<CallExpression>> for Node<'a>

fn from(v: NodeRef<'a, CallExpression>) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Node<ExpressionStatement>> for Node<'a>

fn from(v: NodeRef<'a, ExpressionStatement>) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Node<FunctionExpression>> for Node<'a>

fn from(v: NodeRef<'a, FunctionExpression>) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Node<Identifier>> for Node<'a>

fn from(v: NodeRef<'a, Identifier>) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Node<IfExpression>> for Node<'a>

fn from(v: NodeRef<'a, IfExpression>) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Node<ImportStatement>> for Node<'a>

fn from(v: NodeRef<'a, ImportStatement>) -> Self

Converts to this type from the input type.

impl From<&Node<KclNone>> for KclValue

fn from(none: &Node<KclNone>) -> Self

Converts to this type from the input type.

impl From<&Node<Literal>> for KclValue

fn from(literal: &Node<Literal>) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Node<Literal>> for Node<'a>

fn from(v: NodeRef<'a, Literal>) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Node<MemberExpression>> for Node<'a>

fn from(v: NodeRef<'a, MemberExpression>) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Node<ObjectExpression>> for Node<'a>

fn from(v: NodeRef<'a, ObjectExpression>) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Node<ObjectProperty>> for Node<'a>

fn from(v: NodeRef<'a, ObjectProperty>) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Node<PipeExpression>> for Node<'a>

fn from(v: NodeRef<'a, PipeExpression>) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Node<PipeSubstitution>> for Node<'a>

fn from(v: NodeRef<'a, PipeSubstitution>) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Node<Program>> for Node<'a>

fn from(v: NodeRef<'a, Program>) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Node<ReturnStatement>> for Node<'a>

fn from(v: NodeRef<'a, ReturnStatement>) -> Self

Converts to this type from the input type.

impl<T> From<&Node<T>> for Metadata

fn from(node: NodeRef<'_, T>) -> Self

Converts to this type from the input type.

impl<T> From<&Node<T>> for SourceRange

fn from(v: &Node<T>) -> Self

Converts to this type from the input type.

impl From<&Node<TagDeclarator>> for CompletionItem

fn from(tag: &Node<TagDeclarator>) -> Self

Converts to this type from the input type.

impl From<&Node<TagDeclarator>> for KclValue

fn from(tag: &Node<TagDeclarator>) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Node<TagDeclarator>> for Node<'a>

fn from(v: NodeRef<'a, TagDeclarator>) -> Self

Converts to this type from the input type.

impl From<&Node<TagDeclarator>> for TagIdentifier

fn from(tag: &Node<TagDeclarator>) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Node<UnaryExpression>> for Node<'a>

fn from(v: NodeRef<'a, UnaryExpression>) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Node<VariableDeclaration>> for Node<'a>

fn from(v: NodeRef<'a, VariableDeclaration>) -> Self

Converts to this type from the input type.

impl From<&Node<VariableDeclaration>> for Vec<CompletionItem>

fn from(declaration: &Node<VariableDeclaration>) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Node<VariableDeclarator>> for Node<'a>

fn from(v: NodeRef<'a, VariableDeclarator>) -> Self

Converts to this type from the input type.

impl From<Node<ArrayExpression>> for Expr

fn from(array_expression: Node<ArrayExpression>) -> Self

Converts to this type from the input type.

impl From<Node<ArrayRangeExpression>> for Expr

fn from(array_expression: Node<ArrayRangeExpression>) -> Self

Converts to this type from the input type.

impl From<Node<CallExpression>> for Expr

fn from(call_expression: Node<CallExpression>) -> Self

Converts to this type from the input type.

impl From<Node<Literal>> for Expr

fn from(literal: Node<Literal>) -> Self

Converts to this type from the input type.

impl From<Node<Literal>> for KclValue

fn from(literal: Node<Literal>) -> Self

Converts to this type from the input type.

impl From<Node<PipeExpression>> for Expr

fn from(pipe_expression: Node<PipeExpression>) -> Self

Converts to this type from the input type.

impl From<Node<PipeSubstitution>> for Expr

fn from(pipe_substitution: Node<PipeSubstitution>) -> Self

Converts to this type from the input type.

impl<T> From<Node<T>> for SourceRange

fn from(v: Node<T>) -> Self

Converts to this type from the input type.

impl<T: JsonSchema> JsonSchema for Node<T>

fn schema_name() -> String

The name of the generated JSON Schema.

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.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

impl<T: PartialEq> PartialEq for Node<T>

fn eq(&self, other: &Node<T>) -> 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<T> Serialize for Node<T>

where T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> TS for Node<T>

where T: TS,

type WithoutGenerics = Node<Dummy>

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 TryFrom<Token> for Node<Identifier>

type Error = KclError

The type returned in the event of a conversion error.

fn try_from(token: Token) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Token> for Node<TagDeclarator>

type Error = KclError

The type returned in the event of a conversion error.

fn try_from(token: Token) -> Result<Self, Self::Error>

Performs the conversion.

impl<T> Deref for Node<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: Eq> Eq for Node<T>

impl<T> StructuralPartialEq for Node<T>