actr-cli 0.3.1

Command line tool for Actor-RTC framework projects
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

use crate::template::EchoRole;
use crate::{error::Result, template::ProjectTemplateName};
use async_trait::async_trait;
use std::path::PathBuf;

/// Context for project initialization.
#[derive(Debug, Clone)]
pub struct InitContext {
    pub project_dir: PathBuf,
    pub project_name: String,
    pub signaling_url: String,
    pub manufacturer: String,
    pub template: ProjectTemplateName,
    pub is_current_dir: bool,
    /// Role for echo template: service or app. Ignored for other templates.
    pub echo_role: Option<EchoRole>,
    /// True when this project is being generated as part of a `role=both` pair.
    /// Causes the app to depend on the locally-generated echo-service rather than
    /// the public echo-echo-server registry package.
    pub is_both: bool,
}

/// Interface for language-specific project initialization.
#[async_trait]
pub trait ProjectInitializer: Send + Sync {
    async fn generate_project_structure(&self, context: &InitContext) -> Result<()>;
    fn print_next_steps(&self, context: &InitContext);
}