exers 0.2.0

Library for compiling and running other code in sandboxed environment
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

//! Runtimes for running code.
//!
//! Currently available runtimes are:
//! - [Native](native_runtime)
//! - [WASM](wasm_runtime)

use crate::compilers::CompiledCode;
use std::fmt::Debug;

#[cfg(all(feature = "jailed", feature = "native"))]
pub mod jailed_runtime;
#[cfg(feature = "native")]
pub mod native_runtime;
#[cfg(feature = "wasm")]
pub mod wasm_runtime;

/// Trait for every code runtime.
/// Represents a runtime that can be used to run some code.
pub trait CodeRuntime: Send + Sync + Sized {
    /// Configuration for the runtime.
    type Config: Send + Sync + Sized + Debug + Clone + Default;
    /// Additional compilation data.
    /// This is used to pass additional data from the compiler to the runtime.
    type AdditionalData: Send + Sync + Sized + Debug + Clone + Default;
    /// Error type for the runtime.
    type Error: Send + Sync + Sized + 'static;

    /// Run compiled code. Returns saved output (if any) and exit code.
    fn run(
        &self,
        code: &CompiledCode<Self>,
        config: Self::Config,
    ) -> Result<ExecutionResult, Self::Error>;
}

/// Result of running code.
#[derive(Debug, Clone)]
pub struct ExecutionResult {
    /// Output of the code (if any).
    pub stdout: Option<String>,
    /// Error of the code (if any).
    pub stderr: Option<String>,
    /// Time taken by the code to run.
    pub time_taken: std::time::Duration,
    /// Exit code of the code.
    pub exit_code: i32,
}