embassy-shell 0.2.0

no_std async interactive shell for embassy: bash-like line editing, tab completion and history over any embedded-io-async transport (UART, USB CDC)
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135

name: CI

on:
  push:
    branches: [main, master]
  pull_request:
  workflow_dispatch:

env:
  CARGO_TERM_COLOR: always
  DEFMT_LOG: info

jobs:
  fmt:
    name: Formatting
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: dtolnay/rust-toolchain@stable
        with:
          components: rustfmt
      - name: cargo fmt (library)
        run: cargo fmt --all --check
      - name: cargo fmt (examples)
        # `+stable` pins rustfmt to the stable toolchain: some examples pin
        # nightly in their rust-toolchain.toml (for build-std), where rustfmt
        # is not necessarily installed on the runner. Formatting is checked
        # uniformly with stable rustfmt.
        run: |
          set -e
          for dir in examples/*/; do
            echo "==> fmt $dir"
            (cd "$dir" && cargo +stable fmt --check)
          done

  library:
    name: Library (${{ matrix.name }})
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        include:
          - name: host (clippy + tests)
            args: clippy --workspace --all-targets -- -D warnings
          - name: host (no default features)
            args: clippy --no-default-features --all-targets -- -D warnings
          - name: host (defmt)
            args: clippy --features defmt --all-targets -- -D warnings
          - name: thumbv7em-none-eabihf
            args: check --target thumbv7em-none-eabihf
          - name: riscv32imac-unknown-none-elf
            args: check --target riscv32imac-unknown-none-elf
          # No atomics/M extension: guards against accidentally using them.
          - name: riscv32imc-unknown-none-elf
            args: check --target riscv32imc-unknown-none-elf
    steps:
      - uses: actions/checkout@v4
      - uses: dtolnay/rust-toolchain@stable
        with:
          targets: thumbv7em-none-eabihf, riscv32imac-unknown-none-elf, riscv32imc-unknown-none-elf
          components: clippy
      - uses: Swatinem/rust-cache@v2
      - name: cargo ${{ matrix.args }}
        run: cargo ${{ matrix.args }}

  doc:
    name: Documentation
    runs-on: ubuntu-latest
    env:
      RUSTDOCFLAGS: -D warnings
    steps:
      - uses: actions/checkout@v4
      - uses: dtolnay/rust-toolchain@stable
      - uses: Swatinem/rust-cache@v2
      - run: cargo doc --no-deps

  examples:
    name: ${{ matrix.dir }}
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        include:
          - dir: examples/stm32f411-uart
            toolchain: stable
            targets: thumbv7em-none-eabihf
          - dir: examples/stm32f411-usb
            toolchain: stable
            targets: thumbv7em-none-eabihf
          - dir: examples/nanoch32v305-uart
            toolchain: nightly
          - dir: examples/nanoch32v305-usb
            toolchain: nightly
          - dir: examples/esp32c6-uart
            toolchain: stable
            targets: riscv32imac-unknown-none-elf
            no_default_features: true
          - dir: examples/esp32c6-usb
            toolchain: stable
            targets: riscv32imac-unknown-none-elf
            no_default_features: true
          - dir: examples/esp32c3-uart
            toolchain: stable
            targets: riscv32imc-unknown-none-elf
            no_default_features: true
          - dir: examples/esp32c3-usb
            toolchain: stable
            targets: riscv32imc-unknown-none-elf
            no_default_features: true
    steps:
      - uses: actions/checkout@v4
      - name: Install toolchain
        uses: dtolnay/rust-toolchain@master
        with:
          toolchain: ${{ matrix.toolchain }}
          components: clippy
          targets: ${{ matrix.targets }}
          # nanoch32v305 uses a custom target spec + build-std; its
          # rust-toolchain.toml selects nightly and rust-src.
      - name: Add rust-src (custom-target builds)
        if: ${{ startsWith(matrix.dir, 'examples/nanoch32v305') }}
        run: rustup component add rust-src --toolchain nightly
      - uses: Swatinem/rust-cache@v2
        with:
          workspaces: ${{ matrix.dir }}
      - name: cargo clippy
        working-directory: ${{ matrix.dir }}
        run: cargo clippy -- -D warnings
      - name: cargo clippy (--no-default-features)
        if: ${{ matrix.no_default_features }}
        working-directory: ${{ matrix.dir }}
        run: cargo clippy --no-default-features -- -D warnings
      - name: cargo build
        working-directory: ${{ matrix.dir }}
        run: cargo build