embedded-cli 0.2.1

CLI with autocompletion, help and history for embedded systems (like Arduino or STM32)
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

use core::{convert::Infallible, fmt::Debug};

use embedded_io::{Error, Write};

use crate::{buffer::Buffer, cli::Cli, writer::EmptyWriter};

pub const DEFAULT_CMD_LEN: usize = 40;
pub const DEFAULT_HISTORY_LEN: usize = 100;
pub const DEFAULT_PROMPT: &str = "$ ";

pub struct CliBuilder<W: Write<Error = E>, E: Error, CommandBuffer: Buffer, HistoryBuffer: Buffer> {
    pub(crate) command_buffer: CommandBuffer,
    pub(crate) history_buffer: HistoryBuffer,
    pub(crate) prompt: &'static str,
    pub(crate) writer: W,
}

impl<W, E, CommandBuffer, HistoryBuffer> Debug for CliBuilder<W, E, CommandBuffer, HistoryBuffer>
where
    W: Write<Error = E>,
    E: Error,
    CommandBuffer: Buffer,
    HistoryBuffer: Buffer,
{
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        f.debug_struct("CliBuilder")
            .field("command_buffer", &self.command_buffer.as_slice())
            .field("history_buffer", &self.history_buffer.as_slice())
            .finish()
    }
}

impl<W, E, CommandBuffer, HistoryBuffer> CliBuilder<W, E, CommandBuffer, HistoryBuffer>
where
    W: Write<Error = E>,
    E: Error,
    CommandBuffer: Buffer,
    HistoryBuffer: Buffer,
{
    pub fn build(self) -> Result<Cli<W, E, CommandBuffer, HistoryBuffer>, E> {
        Cli::from_builder(self)
    }

    pub fn command_buffer<B: Buffer>(
        self,
        command_buffer: B,
    ) -> CliBuilder<W, E, B, HistoryBuffer> {
        CliBuilder {
            command_buffer,
            history_buffer: self.history_buffer,
            writer: self.writer,
            prompt: self.prompt,
        }
    }

    pub fn history_buffer<B: Buffer>(
        self,
        history_buffer: B,
    ) -> CliBuilder<W, E, CommandBuffer, B> {
        CliBuilder {
            command_buffer: self.command_buffer,
            history_buffer,
            writer: self.writer,
            prompt: self.prompt,
        }
    }

    pub fn prompt(self, prompt: &'static str) -> Self {
        CliBuilder {
            command_buffer: self.command_buffer,
            history_buffer: self.history_buffer,
            writer: self.writer,
            prompt,
        }
    }

    pub fn writer<T: Write<Error = TE>, TE: Error>(
        self,
        writer: T,
    ) -> CliBuilder<T, TE, CommandBuffer, HistoryBuffer> {
        CliBuilder {
            command_buffer: self.command_buffer,
            history_buffer: self.history_buffer,
            writer,
            prompt: self.prompt,
        }
    }
}

impl Default
    for CliBuilder<EmptyWriter, Infallible, [u8; DEFAULT_CMD_LEN], [u8; DEFAULT_HISTORY_LEN]>
{
    fn default() -> Self {
        Self {
            command_buffer: [0; DEFAULT_CMD_LEN],
            history_buffer: [0; DEFAULT_HISTORY_LEN],
            writer: EmptyWriter,
            prompt: DEFAULT_PROMPT,
        }
    }
}