Struct Environment

pub struct Environment { /* private fields */ }

Represents a single data pipeline configuration environment to run

Implementations

impl Environment

pub fn from_config(config: &str) -> Result<Self, Error>

The function takes the raw configuration of the data pipeline and registers built-in plugins, validates the configuration and returns the Environment to run.

use fiddler::Environment;

let conf_str = r#"input:
 stdin: {}
pipeline:
 processors:
   - label: my_cool_mapping
     noop: {}
output:
 stdout: {}"#;
let env = Environment::from_config(conf_str).unwrap();

pub fn set_label(&mut self, label: Option<String>) -> Result<(), Error>

The function sets the data pipeline with a label.

env.set_label(Some("MyPipeline".into())).unwrap();

or to remove a given label:

env.set_label(None).unwrap();

pub fn get_label(&self) -> Option<String>

The function returns the currect label assigned to the pipeline

assert_eq!(env.get_label().unwrap(), "MyPipeline".to_string());

pub fn set_input(&mut self, input: &HashMap<String, Value>) -> Result<(), Error>

The function replaces the existing input configuration with the provided input.

use serde_yaml::Value;
let conf_str = r#"file:
   filename: tests/data/input.txt
   codec: ToEnd"#;
let parsed_input: HashMap<String, Value> = serde_yaml::from_str(conf_str).unwrap();

env.set_input(&parsed_input).unwrap()

pub fn set_output( &mut self, output: &HashMap<String, Value>, ) -> Result<(), Error>

The function replaces the existing output configuration with the provided output.

use serde_yaml::Value;
let conf_str = r#"stdout: {}"#;
let parsed_output: HashMap<String, Value> = serde_yaml::from_str(conf_str).unwrap();

env.set_output(&parsed_output).unwrap()

pub async fn run(&self) -> Result<(), Error>

The function runs the existing data pipeline until receiving an Error::EndOfInput

env.run().await.unwrap();