flo_scene 0.2.0

Entity-messaging system for composing large programs from small programs
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

use crate::host::scene_message::*;

use serde::*;

use std::borrow::{Cow};

/// The name of the command sent to request a command description
pub const DESCRIBE_COMMAND: &str = "describe_command";

///
/// Provides a detailed description of what a command does
///
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct DescribeCommandResponse {
    /// A summary of what the command does
    pub summary: String,

    /// Markdown that provides a description of what this command does
    pub help: Cow<'static, str>,
}

///
/// Request to describe a particular command
///
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct DescribeCommandRequest(pub String);

impl SceneMessage for DescribeCommandResponse { }
impl SceneMessage for DescribeCommandRequest { }