secret_rs 0.4.2

a library to embed a secret value into a running binary
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

## Local development

>
> ⓘ **Info**
>
> <!-- cSpell:disable  -->
> This repository strive to follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). Please follow them 😊  
> Conventional commits will be parsed with [`git-cliff`](https://git-cliff.org/) to auto-generate `CHANGELOG.md` file.
>

To run tasks in this repository it is necessary to install [rust](https://www.rust-lang.org/) using the following command on Unix:

```shell
# unix
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```

or follow the instructions on the [official page](https://forge.rust-lang.org/infra/other-installation-methods.html#rustup) to install on Windows.

In addition, please install also the following `cargo` plugins:

```shell
cargo install --force cargo-release git-cliff
```

which will help execute tasks such as tagging a new version of the library.

### Development Requirements

- Rust v1.88
- at least a basic knowledge of how to develop with Rust

### Building

To build this project it is enough to run the following command:

```shell
cargo build
```

### Testing

Since this project is a library, only unit-tests are provided. To run them, please launch the following command:

```shell
cargo test --lib
```

### Linting

Linting of project code is performed using `rustfmt` with a customized _nightly_ rule for imports and [`clippy`](https://github.com/rust-lang/rust-clippy). Consequently,
it is necessary to install Rust nightly channel:

```shell
rustup toolchain install nightly
```

and introduce `clippy` as an additional component to the toolchains:

```shell
rustup component add clippy
```

Afterward, it is possible to lint the project with the following commands:

```shell
cargo +nightly fmt --check
cargo clippy --all-targets --all-features
```

---

When using VSCode as editor, we recommend enabling `clippy` as project linter, to get
its warning displayed directly in the editor. This can be achieved by adding this configuration in `.vscode/settings.json` file:

```json
{
  ...,
  "rust-analyzer.check.command": "clippy"
}
```

### Releasing

To create a new version of the service, it is recommended to leverage [`cargo-release`](https://github.com/crate-ci/cargo-release).

```shell
cargo release <major|minor|patch> -p secret_rs --execute
```

For example, the command below creates a new `patch` tag:

```shell
cargo release patch -p secret_rs --execute
```

which it is recommended to then push to the git server.

### Documentation

To view the Rust documentation for this project is possible to execute the following command:
```shell
cargo doc --all-features --open
```