hx-plugins 0.7.1

Plugin system for hx using Steel Scheme
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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

//! Custom command support for plugins.

/// A custom command registered by a plugin.
#[derive(Debug, Clone)]
pub struct CustomCommand {
    /// Command name (what users type after `hx`).
    pub name: String,

    /// Description shown in help.
    pub description: String,

    /// Usage string for help.
    pub usage: Option<String>,

    /// Source plugin that registered this command.
    pub source_plugin: Option<String>,
}

impl CustomCommand {
    /// Create a new custom command.
    pub fn new(name: impl Into<String>) -> Self {
        CustomCommand {
            name: name.into(),
            description: String::new(),
            usage: None,
            source_plugin: None,
        }
    }

    /// Set the description.
    pub fn with_description(mut self, desc: impl Into<String>) -> Self {
        self.description = desc.into();
        self
    }

    /// Set the usage string.
    pub fn with_usage(mut self, usage: impl Into<String>) -> Self {
        self.usage = Some(usage.into());
        self
    }

    /// Set the source plugin.
    pub fn with_source(mut self, source: impl Into<String>) -> Self {
        self.source_plugin = Some(source.into());
        self
    }

    /// Generate help text for this command.
    pub fn help_text(&self) -> String {
        let mut text = String::new();

        if !self.description.is_empty() {
            text.push_str(&self.description);
            text.push('\n');
        }

        if let Some(ref usage) = self.usage {
            text.push('\n');
            text.push_str("Usage: ");
            text.push_str(usage);
            text.push('\n');
        }

        if let Some(ref source) = self.source_plugin {
            text.push('\n');
            text.push_str("(Defined by: ");
            text.push_str(source);
            text.push(')');
        }

        text
    }
}

/// Builder for creating custom commands programmatically.
pub struct CommandBuilder {
    command: CustomCommand,
}

impl CommandBuilder {
    /// Start building a new command.
    pub fn new(name: impl Into<String>) -> Self {
        CommandBuilder {
            command: CustomCommand::new(name),
        }
    }

    /// Set the description.
    pub fn description(mut self, desc: impl Into<String>) -> Self {
        self.command.description = desc.into();
        self
    }

    /// Set the usage string.
    pub fn usage(mut self, usage: impl Into<String>) -> Self {
        self.command.usage = Some(usage.into());
        self
    }

    /// Set the source plugin.
    pub fn source(mut self, source: impl Into<String>) -> Self {
        self.command.source_plugin = Some(source.into());
        self
    }

    /// Build the command.
    pub fn build(self) -> CustomCommand {
        self.command
    }
}