playground-api 0.5.1

Simple API-binding for The Rust Playground
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
68

use serde::{Deserialize, Serialize};

/// Represents the Rust edition to use.
///
/// Each edition introduces new language features and idioms while maintaining compatibility.
#[derive(Debug, Deserialize, Serialize, Clone, Copy, PartialEq, Eq)]
#[cfg_attr(feature = "poise-bot", derive(poise::ChoiceParameter))]
pub enum Edition {
    /// Rust 2024 Edition
    #[cfg_attr(feature = "poise-bot", name = "Edition 2024")]
    #[serde(rename = "2024")]
    Edition2024,

    /// Rust 2021 Edition
    #[cfg_attr(feature = "poise-bot", name = "Edition 2021")]
    #[serde(rename = "2021")]
    Edition2021,

    /// Rust 2018 Edition
    #[cfg_attr(feature = "poise-bot", name = "Edition 2018")]
    #[serde(rename = "2018")]
    Edition2018,

    /// Rust 2015 Edition
    #[cfg_attr(feature = "poise-bot", name = "Edition 2015")]
    #[serde(rename = "2015")]
    Edition2015,
}

/// Defines the type of crate to be compiled: binary or library.
#[derive(Debug, Deserialize, Serialize, Clone, Copy, PartialEq, Eq)]
#[cfg_attr(feature = "poise-bot", derive(poise::ChoiceParameter))]
pub enum CrateType {
    /// A binary crate with a `main` function, compiled to an executable.
    #[serde(rename = "bin")]
    Binary,

    /// A library crate, with a specified library type.
    #[serde(rename = "lib")]
    Library,
}

/// Indicates whether to compile code in debug or release mode.
#[derive(Debug, Deserialize, Serialize, Clone, Copy, PartialEq, Eq)]
#[cfg_attr(feature = "poise-bot", derive(poise::ChoiceParameter))]
#[serde(rename_all = "lowercase")]
pub enum Mode {
    /// Compile with debug information and no optimizations.
    Debug,

    /// Compile with optimizations for performance.
    Release,
}

/// Specifies the Rust release channel to use.
#[derive(Debug, Deserialize, Serialize, Clone, Copy, PartialEq, Eq)]
#[cfg_attr(feature = "poise-bot", derive(poise::ChoiceParameter))]
#[serde(rename_all = "lowercase")]
pub enum Channel {
    /// Stable channel – tested and officially released features.
    Stable,

    /// Beta channel – pre-release testing for the next stable release.
    Beta,

    /// Nightly channel – bleeding-edge features and experimental tools.
    Nightly,
}