Struct Program

pub struct Program<'p> { /* private fields */ }

Jsonnet program state and evaluator.

See the module-level documentation for more information.

Implementations

impl<'p> Program<'p>

pub fn new(arena: &'p Arena) -> Self

Creates a new Program.

pub fn str_interner(&self) -> &StrInterner<'p>

pub fn intern_str(&self, s: &str) -> InternedStr<'p>

pub fn span_manager(&self) -> &SpanManager

pub fn span_manager_mut(&mut self) -> &mut SpanManager

pub fn gc(&mut self)

Runs garbage collection unconditionally.

pub fn maybe_gc(&mut self)

Runs garbage collection under certain conditions.

pub fn set_max_stack(&mut self, max_stack: usize)

Sets the maximum call stack size.

The default is 500.

pub fn get_stdlib_source(&self) -> (SourceId, &[u8])

Returns the source of the part of the standard library that is implemented in Jsonnet.

pub fn add_ext_var(&mut self, name: InternedStr<'p>, thunk: &Thunk<'p>)

Adds an external variable.

External variables can be accessed within a Jsonnet program with the std.extVar function.

pub fn register_native_func( &mut self, name: InternedStr<'p>, params: &[InternedStr<'p>], )

Registers a native function.

Native functions can be accessed within a Jsonnet program with the std.native function.

The actual behavior of the native function should be implemented in Callbacks::native_call.

Panics

Panics if a native function with the same name is already registered or if a parameter name is repeated.

pub fn value_to_thunk(&mut self, value: &Value<'p>) -> Thunk<'p>

Creates a thunk with an already evaluated value.

pub fn make_array(&mut self, items: &[Value<'p>]) -> Value<'p>

Creates an array value.

pub fn make_object( &mut self, obj_fields: &[(InternedStr<'p>, Value<'p>)], ) -> Value<'p>

Creates an object value.

pub fn load_source( &mut self, span_ctx: SpanContextId, input: &[u8], with_stdlib: bool, this_file: &str, ) -> Result<Thunk<'p>, LoadError>

Loads a Jsonnet source into a thunk.

with_stdlib specifies whether the standard library will be available as std. this_file will be the value of std.thisFile.

pub fn eval_value( &mut self, thunk: &Thunk<'p>, callbacks: &mut dyn Callbacks<'p>, ) -> Result<Value<'p>, EvalError>

Evaluates a thunk into a value.

pub fn eval_call( &mut self, func: &Thunk<'p>, pos_args: &[Thunk<'p>], named_args: &[(InternedStr<'p>, Thunk<'p>)], callbacks: &mut dyn Callbacks<'p>, ) -> Result<Value<'p>, EvalError>

Evaluates a function call.

pub fn manifest_json( &mut self, value: &Value<'p>, multiline: bool, ) -> Result<String, EvalError>

Manifests a value as JSON.