Struct rtlola_interpreter::ConfigBuilder

pub struct ConfigBuilder<C: SubConfig, S: ConfigState, OutputTime: OutputTimeRepresentation> { /* private fields */ }

The main entry point of the application. Use the various methods to construct a configuration either for running the interpreter directly or to use the Monitor API interface.

An example construction of the API:

use rtlola_interpreter::ConfigBuilder;
use rtlola_interpreter::monitor::{EventInput, Incremental};
use rtlola_interpreter::{Monitor, Value};
use rtlola_interpreter::time::RelativeFloat;

let monitor: Monitor<_,_,Incremental,_> =
    ConfigBuilder::api()
        .spec_str("input i: Int64")
        .input_time::<RelativeFloat>()
        .event_input::<Vec<Value>>()
        .with_verdict::<Incremental>()
        .monitor();

An example configuration to run the interpreter:

use rtlola_interpreter::ConfigBuilder;
use rtlola_interpreter::monitor::{EventInput, Incremental};
use rtlola_interpreter::{Monitor, Value};
use rtlola_interpreter::config::Verbosity;
use std::path::PathBuf;
use rtlola_interpreter::time::RelativeFloat;

 ConfigBuilder::runnable()
    .spec_str("input a: Int64")
    .input_time::<RelativeFloat>()
    .offline()
    .verbosity(Verbosity::Silent)
    .csv_file_input(PathBuf::from("traces/tests/count_1_2.csv"), None)
    .run();

Implementations

impl ConfigBuilder<ExecConfig<ConfigureMode>, ConfigureIR, RelativeFloat>

pub fn runnable() -> Self

Creates a new executable configuration.

impl ConfigBuilder<ApiConfig<ConfigureInput>, ConfigureIR, RelativeFloat>

pub fn api() -> Self

Creates a new configuration to be used with the API.

impl<C: SubConfig, S: ConfigState, OutputTime: OutputTimeRepresentation> ConfigBuilder<C, S, OutputTime>

pub fn output_time<T: OutputTimeRepresentation>(self) -> ConfigBuilder<C, S, T>

Sets the format in which time is returned. See the README for more details on time formats. For possible formats see the OutputTimeRepresentation trait.

pub fn start_time(self, time: SystemTime) -> Self

Sets the start time of the execution.

impl<C: SubConfig, OutputTime: OutputTimeRepresentation> ConfigBuilder<C, ConfigureIR, OutputTime>

pub fn with_ir(
    self,
    ir: RtLolaMir
) -> ConfigBuilder<C, IrConfigured, OutputTime>

Use an existing ir with the configuration

pub fn spec_file(
    self,
    path: PathBuf
) -> ConfigBuilder<C, IrConfigured, OutputTime>

Read the specification from a file at the given path.

pub fn spec_str(self, spec: &str) -> ConfigBuilder<C, IrConfigured, OutputTime>

Read the specification from the given string.

impl<C: SubConfig, OutputTime: OutputTimeRepresentation> ConfigBuilder<C, IrConfigured, OutputTime>

pub fn input_time<InputTime: TimeRepresentation>(
    self
) -> ConfigBuilder<C, TimeConfigured<InputTime>, OutputTime>

Use an existing ir with the configuration

impl<InputTime: TimeRepresentation, OutputTime: OutputTimeRepresentation> ConfigBuilder<ExecConfig<ConfigureMode>, TimeConfigured<InputTime>, OutputTime>

pub fn offline(
    self
) -> ConfigBuilder<ExecConfig<ConfigureSource>, TimeConfigured<InputTime>, OutputTime>

Sets the execute mode to be offline, i.e. takes the time of events from the input source. The time representation is given as the type parameter. See the README for further details on time representations. For possible TimeRepresentations see the Time Module.

pub fn online(
    self
) -> ConfigBuilder<ExecConfig<ConfigureSource>, TimeConfigured<RealTime>, OutputTime>

Sets the execute mode to be online, i.e. the time of events is taken by the interpreter.

impl<InputTime: TimeRepresentation, OutputTime: OutputTimeRepresentation> ConfigBuilder<ExecConfig<ConfigureSource>, TimeConfigured<InputTime>, OutputTime>

pub fn csv_file_input(
    self,
    path: PathBuf,
    time_col: Option<usize>
) -> ConfigBuilder<ExecConfig<SourceConfigured>, TimeConfigured<InputTime>, OutputTime>

Take the events from a given CSV file at ‘path’. Optionally, the time column in the input can be specified.

pub fn csv_stdin_input(
    self,
    time_col: Option<usize>
) -> ConfigBuilder<ExecConfig<SourceConfigured>, TimeConfigured<InputTime>, OutputTime>

Take the events in CSV format from stdin. Optionally, the time column in the input can be specified.

impl<InputTime: TimeRepresentation, OutputTime: OutputTimeRepresentation> ConfigBuilder<ExecConfig<SourceConfigured>, TimeConfigured<InputTime>, OutputTime>

pub fn delay(
    self,
    delay: Duration
) -> ConfigBuilder<ExecConfig<SourceConfigured>, TimeConfigured<DelayTime>, OutputTime>

A delay is set to ignore the given timestamps in the input and take the delay as the time between the events.

impl<ES: ExecConfigState, S: ConfigState, OutputTime: OutputTimeRepresentation> ConfigBuilder<ExecConfig<ES>, S, OutputTime>

pub fn enable_statistics(self) -> Self

Enable the output of statistics like processes events per second.

pub fn verbosity(self, verbosity: Verbosity) -> Self

Set the output verbosity

pub fn output_to_file(self, path: PathBuf) -> Self

Print the output to a file at path

pub fn output_to_stdout(self) -> Self

Print the output to stdout

pub fn output_to_stderr(self) -> Self

Print the output to stderr

impl<S: ConfigState, OutputTime: OutputTimeRepresentation> ConfigBuilder<ApiConfig<ConfigureInput>, S, OutputTime>

pub fn event_input<E: Into<Event>>(
    self
) -> ConfigBuilder<ApiConfig<InputConfigured<EventInput<E>>>, S, OutputTime>

Use the predefined EventInput method to provide inputs to the API.

pub fn record_input<Inner: Record>(
    self
) -> ConfigBuilder<ApiConfig<InputConfigured<RecordInput<Inner>>>, S, OutputTime>

Use the predefined RecordInput method to provide inputs to the API.

pub fn custom_input<Source: Input>(
    self
) -> ConfigBuilder<ApiConfig<InputConfigured<Source>>, S, OutputTime>

Use a custom input method to provide inputs to the API.

impl<S: ConfigState, OutputTime: OutputTimeRepresentation, Source: Input> ConfigBuilder<ApiConfig<InputConfigured<Source>>, S, OutputTime>

pub fn with_verdict<Verdict: VerdictRepresentation>(
    self
) -> ConfigBuilder<ApiConfig<VerdictConfigured<Source, Verdict>>, S, OutputTime>

Sets the VerdictRepresentation for the monitor

impl<Source: Input, InputTime: TimeRepresentation, Verdict: VerdictRepresentation, OutputTime: OutputTimeRepresentation> ConfigBuilder<ApiConfig<VerdictConfigured<Source, Verdict>>, TimeConfigured<InputTime>, OutputTime>

pub fn build(self) -> MonitorConfig<Source, InputTime, Verdict, OutputTime>

Finalize the configuration and generate a configuration.

pub fn monitor_with_data(
    self,
    data: Source::CreationData
) -> Monitor<Source, InputTime, Verdict, OutputTime>

Create a Monitor from the configuration. The entrypoint of the API. The data is provided to the Input source at creation.

pub fn monitor(self) -> Monitor<Source, InputTime, Verdict, OutputTime> where
    Source: Input<CreationData = ()>, 

Create a Monitor from the configuration. The entrypoint of the API.

impl<InputTime: TimeRepresentation, OutputTime: OutputTimeRepresentation> ConfigBuilder<ExecConfig<SourceConfigured>, TimeConfigured<InputTime>, OutputTime>

pub fn build(self) -> Config<InputTime, OutputTime>

Finalize the configuration and generate a configuration.

pub fn run(self) -> Result<Arc<OutputHandler<OutputTime>>, Box<dyn Error>>

Run the interpreter with the constructed configuration

Trait Implementations

impl<C: Clone + SubConfig, S: Clone + ConfigState, OutputTime: Clone + OutputTimeRepresentation> Clone for ConfigBuilder<C, S, OutputTime>

fn clone(&self) -> ConfigBuilder<C, S, OutputTime>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug + SubConfig, S: Debug + ConfigState, OutputTime: Debug + OutputTimeRepresentation> Debug for ConfigBuilder<C, S, OutputTime>

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

Formats the value using the given formatter.