Struct Pkl

pub struct Pkl<'a> { /* private fields */ }

The Pkl struct represents the main interface for working with PKL data.

Implementations

impl<'a> Pkl<'a>

pub fn new() -> Self

Creates a new, empty Pkl instance.

pub fn parse(&mut self, source: &'a str) -> PklResult<()>

Parses a PKL source string and populates the internal context.

Arguments

• source - The PKL source string to parse.

Returns

A PklResult indicating success or failure.

pub fn generate_ast( &mut self, source: &'a str, ) -> PklResult<Vec<PklStatement<'a>>>

Generates an AST from a PKL source string.

Arguments

• source - The PKL source string to parse.

Returns

A PklResult containing the generated AST or an error message.

pub fn get(&self, name: &'a str) -> Option<&PklValue<'a>>

Retrieves a value from the context by name.

Arguments

• name - The name of the variable to retrieve.

Returns

An Option containing a reference to the PklValue associated with the name, or None if the variable is not found.

pub fn set( &mut self, name: &'a str, value: PklValue<'a>, ) -> Option<PklValue<'a>>

Sets or modifies a value in the context by name.

Arguments

• name - The name of the variable to set.
• value - The value to set.

Returns

An Option containing the previous value associated with the name, if any.

pub fn remove(&mut self, name: &'a str) -> Option<PklValue<'a>>

Removes a value from the context by name.

Arguments

• name - The name of the variable to remove.

Returns

An Option containing the removed value, if any.

pub fn get_bool(&self, name: &'a str) -> PklResult<bool>

Retrieves a boolean value from the context.

Arguments

• name - The name of the variable to retrieve.

Returns

A PklResult containing the boolean value or an error message if not found or wrong type.

pub fn get_int(&self, name: &'a str) -> PklResult<i64>

Retrieves an integer value from the context.

Arguments

• name - The name of the variable to retrieve.

Returns

A PklResult containing the integer value or an error message if not found or wrong type.

pub fn get_float(&self, name: &'a str) -> PklResult<f64>

Retrieves a floating-point value from the context.

Arguments

• name - The name of the variable to retrieve.

Returns

A PklResult containing the floating-point value or an error message if not found or wrong type.

pub fn get_string(&self, name: &'a str) -> PklResult<&'a str>

Retrieves a string value from the context.

Arguments

• name - The name of the variable to retrieve.

Returns

A PklResult containing the string value or an error message if not found or wrong type.

pub fn get_object( &self, name: &'a str, ) -> PklResult<&HashMap<&'a str, PklValue<'a>>>

Retrieves an object value from the context.

Arguments

• name - The name of the variable to retrieve.

Returns

A PklResult containing the object value or an error message if not found or wrong type.

Trait Implementations

impl<'a> Clone for Pkl<'a>

fn clone(&self) -> Pkl<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Pkl<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for Pkl<'a>

fn eq(&self, other: &Pkl<'a>) -> 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<'a> StructuralPartialEq for Pkl<'a>