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

// Copyright (c) The Diem Core Contributors
// SPDX-License-Identifier: Apache-2.0
use crate::common::utils::to_common_result;
use async_trait::async_trait;
use std::fmt::Debug;
use thiserror::Error;

use serde::Serialize;

/// Trait for all CLI commands
#[async_trait]
pub trait Command<T: Serialize + Send>: Sized + Send {
    /// Returns the name of the command
    fn command_name(&self) -> &'static str;

    /// Returns a result from the executed command
    async fn execute(self) -> Result<T, CliError>;

    /// Returns a result from the executed command serialized as JSON
    async fn execute_serialized(self) -> Result<String, String> {
        to_common_result(self.execute().await).await
    }
}

// CLI Errors for logging
#[derive(Debug, Error)]
pub enum CliError {
    #[error("Aborted command")]
    AbortedError,
    #[error("Invalid arguments: {0}")]
    CommandArgumentError(String),
    #[error("Unable to load config: {0}")]
    ConfigLoadError(String),
    #[error("Unable to save config: {0}")]
    ConfigSaveError(String),
    #[error("Unable to find config {0}, have you run `diem init`?")]
    ConfigNotFoundError(String),
    #[error("Error parsing user input: '{0}'")]
    UserInputError(String),
}

impl CliError {
    pub fn to_str(&self) -> &'static str {
        match self {
            CliError::AbortedError => "AbortedError",
            CliError::CommandArgumentError(_) => "CommandArgumentError",
            CliError::ConfigLoadError(_) => "ConfigLoadError",
            CliError::ConfigSaveError(_) => "ConfigSaveError",
            CliError::ConfigNotFoundError(_) => "ConfigNotFoundError",
            CliError::UserInputError(_) => "UserInputError",
        }
    }
}