butterflow-models 0.1.1

A self-hostable workflow engine for code transformations
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use ts_rs::TS;
/// Type of runtime
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, JsonSchema, TS)]
#[serde(rename_all = "lowercase")]
pub enum RuntimeType {
    /// Direct execution on the host
    Direct,

    /// Docker container execution
    Docker,

    /// Podman container execution
    Podman,
}

impl std::fmt::Display for RuntimeType {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            RuntimeType::Direct => write!(f, "direct"),
            RuntimeType::Docker => write!(f, "docker"),
            RuntimeType::Podman => write!(f, "podman"),
        }
    }
}

/// Represents a runtime configuration
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, TS)]
pub struct Runtime {
    /// Type of runtime
    pub r#type: RuntimeType,

    /// Container image (for Docker and Podman)
    #[serde(default)]
    #[ts(optional=nullable)]
    pub image: Option<String>,

    /// Working directory inside the container
    #[serde(default)]
    #[ts(optional=nullable)]
    pub working_dir: Option<String>,

    /// User to run as inside the container
    #[serde(default)]
    #[ts(optional=nullable)]
    pub user: Option<String>,

    /// Network mode for the container
    #[serde(default)]
    #[ts(optional=nullable)]
    pub network: Option<String>,

    /// Additional container options
    #[serde(default)]
    #[ts(optional=nullable)]
    pub options: Option<Vec<String>>,
}