This crate makes use of serde to convert files into rust Structs. In other words it casts files into Structs.

It converts:

• configuration files -> cast::Config;
• log files -> cast::Log.

Load a Config or a Log struct from a filepath.

Loads logs from a file path.

let res = cast::Config::load("./public/pipelight.ts", None)?;

Loads logs from a directory path.

let res = cast::Logs::load("./pipelight/logs", None)?;

The resulting cast structs are just dummy file conversion. They are not to be used as is as they don't implement any useful methods.

The cast Structs are further converted into convenient workflow Structs.

File -> Cast::Pipeline -> Workflow::Pipeline

I have splited the conversion utilities from the engine core, but why such an abstraction?

If you dive into the code and read the documented sections you will soon understand that the configuration file you write in ts, toml and yaml is quite different from its rust Struct.

The config you write is flatten, computed, hydrated, sanitized and completed with default values in order to be enjoyable in rust programming.

This crate only serve the casting purpose to convert all these file types into concistent structs and return colorful errors.