Struct InstanceBuilder

pub struct InstanceBuilder<'a, L> { /* private fields */ }

Builder for compiling a script into an executable Instance.

Implementations

impl<'a, L> InstanceBuilder<'a, L>

pub fn with_path(self, path: &'a str) -> Self

Sets the source path used for diagnostics.

pub fn with_input_value(self, id: usize, value: impl Serialize) -> Self

Set the value of an input by its index.

The id corresponds to the position of the input in the script’s input.*() declarations (0-based). Use script_info() to inspect available inputs and their types.

Examples

use openpine_vm::{Candlestick, Instance, TimeFrame};

let source = r#"
    //@version=6
    indicator("With Inputs")
    int length = input.int(14, "Length")
    plot(ta.sma(close, length))
"#;
let provider = Vec::<Candlestick>::new();
let instance = Instance::builder(provider, source, TimeFrame::days(1), "NASDAQ:AAPL")
    .with_input_value(0, 20) // Override "Length" from 14 to 20
    .build()
    .await?;

pub fn with_locale(self, locale: &'a str) -> Self

Sets the locale passed into compilation/typechecking.

pub fn with_input_sessions(self, sessions: InputSessions) -> Self

Configures which trading sessions are accepted as input.

pub fn with_background_color(self, color: impl Into<Option<Color>>) -> Self

Overrides the chart background color used by visual outputs.

pub fn with_last_info(self, last_info: impl Into<Option<LastInfo>>) -> Self

Provides the last-bar metadata used by some runtime features.

pub fn with_currency_converter( self, converter: Box<dyn CurrencyConverter>, ) -> Self

Sets a custom currency converter for cross-currency backtesting.

The converter is called by strategy.convert_to_account() and strategy.convert_to_symbol(). When not set, an identity converter is used (returns the input value unchanged).

pub fn with_execution_limits(self, limits: ExecutionLimits) -> Self

Configures runtime execution limits for the VM.

See ExecutionLimits for available options. When not called, sensible defaults are used.

pub fn with_output_mode(self, mode: OutputMode) -> Self

Sets the output mode for series graph data.

• OutputMode::Chart (default): native functions write directly to the chart. No DrawEvent events are emitted.
• OutputMode::Stream: native functions emit DrawEvent events instead of updating the chart.

impl<'a, L> InstanceBuilder<'a, L>

where L: LibraryLoader,

pub fn with_library_loader<Q>( self, library_loader: Q, ) -> InstanceBuilder<'a, CombinedLoader<Q, L>>

where Q: LibraryLoader,

Chains an additional library loader in front of the current loader.

pub async fn build(self) -> Result<Instance, Error>

Compiles the script and builds a runnable Instance.

This compiles the Pine Script source, resolves inputs, and prepares the VM for execution. Returns an error if compilation fails or if an invalid input value was provided.

Examples

use openpine_vm::{Candlestick, Instance, TimeFrame};

let source = r#"
    //@version=6
    indicator("SMA Example")
    plot(ta.sma(close, 20))
"#;
let provider = Vec::<Candlestick>::new();
let instance = Instance::builder(provider, source, TimeFrame::days(1), "NASDAQ:AAPL")
    .build()
    .await?;

// The instance is now ready to receive candlestick data via `run()`
println!("Script type: {:?}", instance.script_info().script_type);