endbyte 0.1.0

A no_std compatible rust library for handling byte order conversions between different endianness formats.
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

name: build

on:
  push:
    branches: [ "main" ]
  pull_request:
    branches: [ "main" ]

env:
  CARGO_TERM_COLOR: always

jobs:
  test:
    name: test on ${{ matrix.rust }}
    runs-on: ubuntu-latest
    strategy:
      matrix:
        rust: [stable, beta, nightly]

    steps:
    - uses: actions/checkout@v4
    - uses: dtolnay/rust-toolchain@master
      with:
        toolchain: ${{ matrix.rust }}
    - name: build library
      run: cargo build --verbose
    - name: run tests
      run: cargo test --verbose --lib
    - name: run tests in release mode
      run: cargo test --verbose --lib --release

  no_std:
    name: no_std compatibility
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v4
    - uses: dtolnay/rust-toolchain@stable
    - name: install embedded targets
      run: |
        rustup target add thumbv7em-none-eabihf
        rustup target add thumbv6m-none-eabi
        rustup target add thumbv7m-none-eabi
        rustup target add thumbv8m.main-none-eabi
    - name: build for cortex-m4f
      run: cargo build --target thumbv7em-none-eabihf --verbose
    - name: build for cortex-m0
      run: cargo build --target thumbv6m-none-eabi --verbose
    - name: build for cortex-m3
      run: cargo build --target thumbv7m-none-eabi --verbose
    - name: build for cortex-m33
      run: cargo build --target thumbv8m.main-none-eabi --verbose
    - name: build embedded example for cortex-m4f
      run: cargo build --example embedded_test --target thumbv7em-none-eabihf --features="embedded" --verbose
    - name: build embedded example for cortex-m0
      run: cargo build --example embedded_test --target thumbv6m-none-eabi --features="embedded" --verbose
    - name: build asm test example
      run: cargo build --example asm_test --verbose
    - name: build all targets in release mode
      run: |
        cargo build --target thumbv7em-none-eabihf --release --verbose
        cargo build --target thumbv6m-none-eabi --release --verbose
        cargo build --example embedded_test --target thumbv7em-none-eabihf --features="embedded" --release --verbose

  clippy:
    name: clippy
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v4
    - uses: dtolnay/rust-toolchain@stable
      with:
        components: clippy
    - name: install embedded targets for clippy
      run: rustup target add thumbv7em-none-eabihf
    - name: run clippy on library
      run: cargo clippy --lib -- -D warnings
    - name: run clippy on asm test example
      run: cargo clippy --example asm_test -- -D warnings
    - name: run clippy on embedded test example
      run: cargo clippy --example embedded_test --target thumbv7em-none-eabihf --features="embedded" -- -D warnings

  fmt:
    name: rustfmt
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v4
    - uses: dtolnay/rust-toolchain@stable
      with:
        components: rustfmt
    - name: check formatting
      run: cargo fmt --all -- --check

  docs:
    name: docs
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v4
    - uses: dtolnay/rust-toolchain@stable
    - name: build docs
      run: cargo doc --no-deps --verbose

  dependencies:
    name: check dependencies
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v4
    - uses: dtolnay/rust-toolchain@stable
    - name: verify zero dependencies
      run: |
        deps=$(cargo tree --depth 0 | grep -v "^endbyte" | wc -l)
        if [ "$deps" -ne 0 ]; then
          echo "error: library should have zero dependencies"
          cargo tree
          exit 1
        fi
        echo "verified: library has zero dependencies"