virtx 0.1.0

Run tasks in disposable Linux VMs from your own code: the environment an agent works in.
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
59
60
61
62
63
64
65
66
67

use serde::{Deserialize, Serialize};

use crate::protocol::message::utils::bytes;

/// One execution. The `params` of `exec`.
///
/// Only a command and a time bound: where it runs is the session's, what it runs with is
/// the executor's. It takes no stdin: stage input with a [`WriteCall`](super::WriteCall)
/// beforehand and collect output files with a [`ReadCall`](super::ReadCall) after.
#[derive(Clone, Debug, Default, PartialEq, Eq, Serialize, Deserialize)]
pub struct ExecCall {
    /// The argv. No shell is involved; for shell semantics send `["sh", "-c", "..."]`.
    ///
    /// UTF-8, since an argv is a list of `String`s by the time anything runs it. An empty
    /// one is refused at spawn; see [`split`](Self::split).
    pub cmd: Vec<String>,

    /// Milliseconds before the executor kills it. `None` is no limit, and there is no
    /// session-wide default, so a never-ending command without one never ends.
    ///
    /// Expiry is an immediate kill with no grace period or second signal: a simple rule
    /// every backend (including a micro-VM guest) can keep. The requester gets
    /// [`TIMED_OUT`](crate::protocol::Error::TIMED_OUT).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub timeout_ms: Option<u64>,
}

impl ExecCall {
    /// The program and its arguments; `None` for an empty argv, which the spawner refuses
    /// as [`INVALID_PARAMS`](crate::protocol::Error::INVALID_PARAMS).
    pub fn split(&self) -> Option<(&String, &[String])> {
        self.cmd.split_first()
    }
}

/// A whole execution: everything it wrote, and how it ended. The `result` of `exec`.
///
/// An execution with no result (killed at its timeout, never started) is an `error` with
/// a code instead (see [`Error`](crate::protocol::Error)), since an exit code (e.g.
/// 126/127) could be forged by `exit()`.
///
/// Sent unwrapped, so later additions are new members, which older peers ignore.
///
/// Whole, never streamed: the caller is an agent that cannot act on partial output before
/// its next inference, so streaming would buy only a second shape and code path.
///
/// The session's current directory is not reported, even if the command moved it: a
/// result describes the command, not the machine. Run `pwd` to ask.
#[derive(Clone, Debug, Default, PartialEq, Eq, Serialize, Deserialize)]
pub struct ExecResp {
    /// For a command killed by a signal, `128 + signal` by convention.
    pub code: i32,

    /// Kept apart from [`stderr`](Self::stderr) because a requester can merge but not
    /// un-merge. Interleaving is not preserved; use `2>&1` if order matters.
    #[serde(with = "bytes")]
    pub stdout: Vec<u8>,

    #[serde(with = "bytes")]
    pub stderr: Vec<u8>,

    /// The output outgrew one message under [`MAX_PAYLOAD`](crate::protocol::MAX_PAYLOAD)
    /// and what is here is its beginning; flagged so an agent does not reason from output
    /// it takes as complete.
    #[serde(default)]
    pub truncated: bool,
}