serialport 4.10.0

A cross-platform low-level serial port library.
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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404

name: CI

on:
  pull_request:
    branches:
      - main
      - playground-5.0
  push:
  # Check for new issues from updated dependencies once a week (Friday noon).
  schedule:
    - cron: "0 12 * * 5"
  workflow_dispatch:

jobs:
  # --------------------------------------------------------------------------
  # Formatting

  fmt:
    runs-on: ubuntu-latest
    steps:
        # TODO: Harmonize with build.yaml
      - name: Fmt | checkout
        uses: actions/checkout@v6

      - name: Fmt | install toolchain
        uses: dtolnay/rust-toolchain@stable
        with:
          toolchain: stable
          components: clippy, rustfmt

      - name: Fmt | rust-cache
        uses: Swatinem/rust-cache@v2

      - name: Fmt | check formatting
        run: cargo fmt -- --check

  # --------------------------------------------------------------------------
  # Clippy lints

  clippy:
    runs-on: ubuntu-latest
    env:
      RUSTFLAGS: -Dwarnings
    strategy:
      matrix:
        target:
          - aarch64-apple-darwin
          - arm-linux-androideabi
          - x86_64-pc-windows-msvc
          - x86_64-unknown-freebsd
          - x86_64-unknown-illumos
          - x86_64-unknown-linux-gnu
          - x86_64-unknown-netbsd
      fail-fast: false
    steps:
      # TODO: Harmonize with build.yaml
      - run: |
          sudo sed -i 's/azure.archive.ubuntu.com/archive.ubuntu.com/' /etc/apt/sources.list
          sudo apt-get -qq update
          sudo apt install -qq -y libudev-dev
      - uses: actions/checkout@v6
      - uses: dtolnay/rust-toolchain@stable
        with:
          target: ${{ matrix.target }}
      - uses: swatinem/rust-cache@v2
        # Pin some dependencies (for Clippy and our MSRV 1.59.0) just here in
        # CI and not via Cargo.toml. The latter would enforce them to all users
        # and not just the ones who want to build with an old Rust release. See
        # issue https://github.com/serialport/serialport-rs/issues/324.
        #
        # The command line arguments below are for Cargo 1.59.0. The have
        # changed with newer releases and need to be adjusted when bumbing our
        # MSRV.
        #
        # NOTE: Please keep in sync with pinning for build jobs in build.yaml.
      - name: Build | pin some dependencies for building with MSRV
        run: |
          cargo update --precise 0.10.0 --package core-foundation
          cargo update --precise 0.2.163 --package libc
          cargo update --precise 0.3.33 --package pkg-config
          cargo update --precise 1.0.101 --package proc-macro2
          cargo update --precise 1.0.40 --package quote
          cargo update --precise 1.0.22 --package unicode-ident
      - run: cargo clippy --target ${{ matrix.target }}
      - run: cargo clippy --target ${{ matrix.target }} --all-features


  # --------------------------------------------------------------------------
  # Rustdoc

  doc:
    name: documentation
    runs-on: ubuntu-latest
    env:
      RUSTDOCFLAGS: -Dwarnings
    steps:
      - name: documentation | install dependencies
        # TODO: Harmonize with build.yaml
        run: |
          sudo sed -i 's/azure.archive.ubuntu.com/archive.ubuntu.com/' /etc/apt/sources.list
          sudo apt-get -qq update
          sudo apt install -qq -y libudev-dev
      - uses: actions/checkout@v6
      - uses: dtolnay/rust-toolchain@nightly
      - uses: dtolnay/install@cargo-docs-rs
      - run: cargo docs-rs

  # --------------------------------------------------------------------------
  # Link checks

  links:
    runs-on: ubuntu-latest
    steps:
      - name: Links | checkout
        uses: actions/checkout@v6

      - name: Links | check
        id: lychee
        uses: lycheeverse/lychee-action@v2
        with:
          fail: true

  # --------------------------------------------------------------------------
  # MSRV
  #
  # Check at least once per platform.

  msrv-aarch64-apple-darwin:
    uses: ./.github/workflows/build.yaml
    with:
      disable_extra_builds: true
      disable_tests: true
      target: aarch64-apple-darwin
      toolchain: "1.59.0"
      pin-incompatible-msrv-bump-dependencies: true

  msrv-arm-linux-androideabi:
    uses: ./.github/workflows/build.yaml
    with:
      disable_extra_builds: true
      disable_tests: true
      target: arm-linux-androideabi
      toolchain: "1.59.0"
      pin-incompatible-msrv-bump-dependencies: true

  msrv-x86_64-unknown-freebsd:
    uses: ./.github/workflows/build.yaml
    with:
      disable_extra_builds: true
      disable_tests: true
      target: x86_64-unknown-freebsd
      toolchain: "1.59.0"
      pin-incompatible-msrv-bump-dependencies: true

  msrv-x86_64-unknown-linux-gnu:
    uses: ./.github/workflows/build.yaml
    with:
      disable_extra_builds: true
      disable_tests: true
      extra_packages: libudev-dev
      target: x86_64-unknown-linux-gnu
      toolchain: "1.59.0"
      pin-incompatible-msrv-bump-dependencies: true

  msrv-x86_64-unknown-linux-musl:
    uses: ./.github/workflows/build.yaml
    with:
      disable_extra_builds: true
      disable_tests: true
      extra_packages: gcc-aarch64-linux-gnu
      target: aarch64-unknown-linux-musl
      toolchain: "1.59.0"
      pin-incompatible-msrv-bump-dependencies: true

  msrv-x86_64-pc-windows-msvc:
    uses: ./.github/workflows/build.yaml
    with:
      disable_extra_builds: true
      disable_tests: true
      runs_on: windows-2025
      target: x86_64-pc-windows-msvc
      toolchain: "1.59.0"
      pin-incompatible-msrv-bump-dependencies: true

  msrv-x86_64-unknown-netbsd:
    uses: ./.github/workflows/build.yaml
    with:
      disable_extra_builds: true
      disable_tests: true
      target: x86_64-unknown-netbsd
      toolchain: "1.59.0"
      pin-incompatible-msrv-bump-dependencies: true
  msrv-x86_64-unknown-illumos:
    uses: ./.github/workflows/build.yaml
    with:
      disable_extra_builds: true
      disable_tests: true
      target: x86_64-unknown-illumos
      toolchain: "1.59.0"
      pin-incompatible-msrv-bump-dependencies: true



  # --------------------------------------------------------------------------
  # Semantic Versioning
  #
  # Check at least once per platform as we heavily depend on platform-specific
  # code. The feature groups are used for attempting to cover different
  # backends for a platform (like Linux with and without libudev).

  semver:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        target:
          - aarch64-apple-darwin
          - arm-linux-androideabi
          - x86_64-pc-windows-msvc
          - x86_64-unknown-freebsd
          - x86_64-unknown-linux-gnu
          - x86_64-unknown-netbsd
          # FIXME: Add x86_64-unknown-illumos after a release
        feature-group:
          - "only-explicit-features"
          - "all-features"
    steps:
      # TODO: Harmonize with build.yaml
      - run: |
          sudo sed -i 's/azure.archive.ubuntu.com/archive.ubuntu.com/' /etc/apt/sources.list
          sudo apt-get -qq update
          sudo apt-get -qq -y install build-essential curl git pkg-config libudev-dev
      - uses: actions/checkout@v6
      - uses: dtolnay/rust-toolchain@stable
        with:
          target: ${{ matrix.target }}
      - uses: Swatinem/rust-cache@v2
      - uses: obi1kenobi/cargo-semver-checks-action@v2
        with:
          rust-target: ${{ matrix.target }}
          feature-group: ${{ matrix.feature-group }}

  # --------------------------------------------------------------------------
  # cargo-deny

  cargo-deny:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        checks:
          - advisories
          - bans licenses sources

    # Prevent sudden announcement of a new advisory from failing ci:
    continue-on-error: ${{ matrix.checks == 'advisories' }}

    steps:
    - uses: actions/checkout@v6
    - uses: EmbarkStudios/cargo-deny-action@v2
      with:
        command: check ${{ matrix.checks }}

  # --------------------------------------------------------------------------
  # BUILD

  aarch64-apple-darwin:
    uses: ./.github/workflows/build.yaml
    with:
      disable_tests: true
      runs_on: macos-latest
      target: aarch64-apple-darwin

  aarch64-apple-ios:
    uses: ./.github/workflows/build.yaml
    with:
      disable_tests: true
      runs_on: macos-latest
      target: aarch64-apple-ios

  aarch64-unknown-linux-gnu:
    uses: ./.github/workflows/build.yaml
    with:
      disable_extra_builds: true
      disable_tests: true
      extra_packages: libudev-dev gcc-aarch64-linux-gnu libc6-dev-arm64-cross
      target: aarch64-unknown-linux-gnu

  aarch64-unknown-linux-musl:
    uses: ./.github/workflows/build.yaml
    with:
      disable_tests: true
      extra_packages: gcc-aarch64-linux-gnu
      target: aarch64-unknown-linux-musl

  arm-linux-androideabi:
    uses: ./.github/workflows/build.yaml
    with:
      disable_extra_builds: true
      disable_tests: true
      target: arm-linux-androideabi

  armv7-linux-androideabi:
    uses: ./.github/workflows/build.yaml
    with:
      disable_extra_builds: true
      disable_tests: true
      target: armv7-linux-androideabi

  i686-pc-windows-msvc:
    uses: ./.github/workflows/build.yaml
    with:
      runs_on: windows-2025
      target: i686-pc-windows-msvc

  i686-unknown-linux-gnu:
    uses: ./.github/workflows/build.yaml
    with:
      disable_extra_builds: true
      disable_tests: true
      extra_packages: libudev-dev gcc-multilib
      target: i686-unknown-linux-gnu

  i686-unknown-linux-musl:
    uses: ./.github/workflows/build.yaml
    with:
      extra_packages: libudev-dev gcc-multilib
      target: i686-unknown-linux-musl

  x86_64-apple-darwin:
    uses: ./.github/workflows/build.yaml
    with:
      runs_on: macos-latest
      target: x86_64-apple-darwin

  x86_64-pc-windows-gnu:
    uses: ./.github/workflows/build.yaml
    with:
      runs_on: windows-2025
      target: x86_64-pc-windows-gnu

  x86_64-pc-windows-msvc:
    uses: ./.github/workflows/build.yaml
    with:
      runs_on: windows-2025
      target: x86_64-pc-windows-msvc

  x86_64-unknown-freebsd:
    uses: ./.github/workflows/build.yaml
    with:
      disable_extra_builds: true
      disable_tests: true
      target: x86_64-unknown-freebsd

  x86_64-unknown-linux-gnu:
    uses: ./.github/workflows/build.yaml
    with:
      extra_packages: libudev-dev
      target: x86_64-unknown-linux-gnu

  x86_64-unknown-linux-musl:
    uses: ./.github/workflows/build.yaml
    with:
      target: x86_64-unknown-linux-musl

  x86_64-unknown-netbsd:
    uses: ./.github/workflows/build.yaml
    with:
      disable_extra_builds: true
      disable_tests: true
      target: x86_64-unknown-netbsd
  x86_64-unknown-illumos:
    uses: ./.github/workflows/build.yaml
    with:
      disable_extra_builds: true
      disable_tests: true
      target: x86_64-unknown-illumos

  # --------------------------------------------------------------------------
  # NIGHTLY BUILD

  aarch64-apple-darwin-nightly:
    uses: ./.github/workflows/build.yaml
    with:
      continue-on-error: true
      disable_tests: true
      runs_on: macos-latest
      target: aarch64-apple-darwin
      toolchain: nightly

  x86_64-pc-windows-msvc-nightly:
    uses: ./.github/workflows/build.yaml
    with:
      continue-on-error: true
      runs_on: windows-2025
      target: x86_64-pc-windows-msvc
      toolchain: nightly

  x86_64-unknown-linux-gnu-nightly:
    uses: ./.github/workflows/build.yaml
    with:
      continue-on-error: true
      extra_packages: libudev-dev
      target: x86_64-unknown-linux-gnu
      toolchain: nightly