Struct Program 

pub struct Program {
    pub ast: Node<Program>,
    pub original_file_contents: String,
}

Fields

ast: Node<Program>

original_file_contents: String

Implementations

impl Program

pub fn parse( input: &str, ) -> Result<(Option<Program>, Vec<CompilationIssue>), KclError>

pub fn parse_no_errs(input: &str) -> Result<Program, KclError>

pub fn compute_digest(&mut self) -> [u8; 32]

pub fn meta_settings(&self) -> Result<Option<MetaSettings>, KclError>

Get the meta settings for the kcl file from the annotations.

pub fn change_default_units( &self, length_units: Option<UnitLength>, ) -> Result<Self, KclError>

Change the meta settings for the kcl file.

pub fn change_experimental_features( &self, warning_level: Option<WarningLevel>, ) -> Result<Self, KclError>

pub fn is_empty_or_only_settings(&self) -> bool

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

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

pub fn node_path_from_range( &self, cached_body_items: usize, range: SourceRange, ) -> Option<NodePath>

pub fn fill_node_paths(self) -> Program

Fill node paths and consume the input so that the program without paths isn’t accidentally used. Filling node paths happens automatically during parsing. Calling this is only needed after the caller invalidates the node paths such as by mutating an AST or by making a round-trip through serialization.

pub fn recast(&self) -> String

pub fn recast_with_options(&self, options: &FormatOptions) -> String

pub fn empty() -> Self

Create an empty program.

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

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