Skip to content

Commit 3422053

Browse files
geeknoidMartin Taillefer
andauthored
docs: A few doc-related fixes. (#198)
- Workaround a bug in cargo-doc2readme where it produces bogus links for intra-doc links using () to reference to functions. I've filed a bug against cargo-doc2readme on the subject. - Extend the release-crate.ps1 script to introduce the --bump option to let you just bump the patch version, the minor version, or the major version. This avoids the need to actually know the current version number, the script figures it out. - Bumped some crate versions to get the fixed README files published to crates.io. Co-authored-by: Martin Taillefer <mataille@microsoft.com>
1 parent 83e9462 commit 3422053

File tree

11 files changed

+174
-98
lines changed

11 files changed

+174
-98
lines changed

Cargo.lock

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ repository = "https://github.com/microsoft/oxidizer"
2424
[workspace.dependencies]
2525

2626
# local dependencies
27-
bytesbuf = { path = "crates/bytesbuf", default-features = false, version = "0.2.1" }
27+
bytesbuf = { path = "crates/bytesbuf", default-features = false, version = "0.2.2" }
2828
bytesbuf_io = { path = "crates/bytesbuf_io", default-features = false, version = "0.1.1" }
29-
data_privacy = { path = "crates/data_privacy", default-features = false, version = "0.10.0" }
29+
data_privacy = { path = "crates/data_privacy", default-features = false, version = "0.10.1" }
3030
data_privacy_macros = { path = "crates/data_privacy_macros", default-features = false, version = "0.9.0" }
3131
data_privacy_macros_impl = { path = "crates/data_privacy_macros_impl", default-features = false, version = "0.9.0" }
3232
fundle = { path = "crates/fundle", default-features = false, version = "0.3.0" }

crates/bytesbuf/CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@
1010

1111
- Replace removed doc_auto_cfg feature with doc_cfg ([#178](https://github.com/microsoft/oxidizer/pull/178))
1212

13+
- ✔️ Tasks
14+
15+
- Bump bytesbuf and bytesbuf_io version numbers to re-trigger publishing ([#188](https://github.com/microsoft/oxidizer/pull/188))
16+
1317
## [0.2.0] - 2026-01-02
1418

1519
- ✨ Features

crates/bytesbuf/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[package]
55
name = "bytesbuf"
66
description = "Types for creating and manipulating byte sequences."
7-
version = "0.2.1"
7+
version = "0.2.2"
88
readme = "README.md"
99
keywords = ["oxidizer", "buffers", "io", "zero-copy"]
1010
categories = ["data-structures", "network-programming"]

crates/bytesbuf/README.md

Lines changed: 61 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ using the fundamental methods that underpin the convenience methods:
177177
See `examples/bb_slice_by_slice_write.rs` for an example of how to use these methods.
178178

179179
If you do not know exactly how much memory you need in advance, you can extend the [`BytesBuf`][__link35]
180-
capacity on demand by calling [`BytesBuf::reserve()`][__link36]. You can use [`remaining_capacity()`][__link37]
180+
capacity on demand by calling [`BytesBuf::reserve`][__link36]. You can use [`remaining_capacity()`][__link37]
181181
to identify how much unused memory capacity is available.
182182

183183
```rust
@@ -236,7 +236,7 @@ let final_contents = buf.consume_all();
236236
```
237237

238238
If you already have a [`BytesView`][__link41] that you want to write into a [`BytesBuf`][__link42], call
239-
[`BytesBuf::put_bytes()`][__link43]. This is a highly efficient zero-copy operation
239+
[`BytesBuf::put_bytes`][__link43]. This is a highly efficient zero-copy operation
240240
that reuses the memory capacity of the view you are appending.
241241

242242
```rust
@@ -470,67 +470,67 @@ See the `mem::testing` module for details (requires `test-util` Cargo feature).
470470
This crate was developed as part of <a href="../..">The Oxidizer Project</a>. Browse this crate's <a href="https://github.com/microsoft/oxidizer/tree/main/crates/bytesbuf">source code</a>.
471471
</sub>
472472

473-
[__cargo_doc2readme_dependencies_info]: ggGkYW0CYXSEGy4k8ldDFPOhG2VNeXtD5nnKG6EPY6OfW5wBG8g18NOFNdxpYXKEG49D8RruQIE8GwgpxEsyod4nG_0iVUF-Z1CbG8k9bXXtSjKnYWSBgmhieXRlc2J1ZmUwLjIuMQ
474-
[__link0]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesBuf
475-
[__link1]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesView
476-
[__link10]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesView::advance
477-
[__link11]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesView::first_slice
478-
[__link12]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesView::first_slice
479-
[__link13]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesView::first_slice
480-
[__link14]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesView
481-
[__link15]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=mem::Memory
482-
[__link16]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=mem::HasMemory
483-
[__link17]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=mem::HasMemory::memory
484-
[__link18]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=mem::GlobalPool
485-
[__link19]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=mem::GlobalPool::new
486-
[__link2]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesView
487-
[__link20]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=mem::Memory::reserve
488-
[__link21]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesBuf
489-
[__link22]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesBuf
490-
[__link23]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesBuf
491-
[__link24]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesBuf
492-
[__link25]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesBuf::put_num_le
493-
[__link26]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesBuf::put_slice
494-
[__link27]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesBuf::put_byte
495-
[__link28]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesBuf::put_byte_repeated
496-
[__link29]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesBuf::put_bytes
497-
[__link3]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesView::get_num_le
498-
[__link30]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesView
499-
[__link31]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesBuf::first_unfilled_slice
500-
[__link32]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesBuf::advance
501-
[__link33]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesBuf::first_unfilled_slice
502-
[__link34]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesBuf::first_unfilled_slice
503-
[__link35]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesBuf
504-
[__link36]: `BytesBuf::reserve()`
505-
[__link37]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesBuf::remaining_capacity
506-
[__link38]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesBuf
507-
[__link39]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesView
508-
[__link4]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesView::get_byte
509-
[__link40]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesBuf
510-
[__link41]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesView
511-
[__link42]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesBuf
512-
[__link43]: `BytesBuf::put_bytes()`
513-
[__link44]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=mem::HasMemory
514-
[__link45]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=mem::HasMemory
515-
[__link46]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesView
516-
[__link47]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesBuf
517-
[__link48]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=mem::HasMemory
518-
[__link49]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesView
519-
[__link5]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesView::copy_to_slice
520-
[__link50]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesBuf
521-
[__link51]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=mem::HasMemory
522-
[__link52]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=mem::HasMemory
523-
[__link53]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=mem::GlobalPool
473+
[__cargo_doc2readme_dependencies_info]: ggGkYW0CYXSEGy4k8ldDFPOhG2VNeXtD5nnKG6EPY6OfW5wBG8g18NOFNdxpYXKEGzZ-2Bc0fJD6G7j5NnIMCIG1G7ArxDjgq_0oG2r2CxKzSq0VYWSBgmhieXRlc2J1ZmUwLjIuMg
474+
[__link0]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesBuf
475+
[__link1]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesView
476+
[__link10]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesView::advance
477+
[__link11]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesView::first_slice
478+
[__link12]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesView::first_slice
479+
[__link13]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesView::first_slice
480+
[__link14]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesView
481+
[__link15]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=mem::Memory
482+
[__link16]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=mem::HasMemory
483+
[__link17]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=mem::HasMemory::memory
484+
[__link18]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=mem::GlobalPool
485+
[__link19]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=mem::GlobalPool::new
486+
[__link2]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesView
487+
[__link20]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=mem::Memory::reserve
488+
[__link21]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesBuf
489+
[__link22]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesBuf
490+
[__link23]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesBuf
491+
[__link24]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesBuf
492+
[__link25]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesBuf::put_num_le
493+
[__link26]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesBuf::put_slice
494+
[__link27]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesBuf::put_byte
495+
[__link28]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesBuf::put_byte_repeated
496+
[__link29]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesBuf::put_bytes
497+
[__link3]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesView::get_num_le
498+
[__link30]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesView
499+
[__link31]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesBuf::first_unfilled_slice
500+
[__link32]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesBuf::advance
501+
[__link33]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesBuf::first_unfilled_slice
502+
[__link34]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesBuf::first_unfilled_slice
503+
[__link35]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesBuf
504+
[__link36]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesBuf::reserve
505+
[__link37]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesBuf::remaining_capacity
506+
[__link38]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesBuf
507+
[__link39]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesView
508+
[__link4]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesView::get_byte
509+
[__link40]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesBuf
510+
[__link41]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesView
511+
[__link42]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesBuf
512+
[__link43]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesBuf::put_bytes
513+
[__link44]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=mem::HasMemory
514+
[__link45]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=mem::HasMemory
515+
[__link46]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesView
516+
[__link47]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesBuf
517+
[__link48]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=mem::HasMemory
518+
[__link49]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesView
519+
[__link5]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesView::copy_to_slice
520+
[__link50]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesBuf
521+
[__link51]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=mem::HasMemory
522+
[__link52]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=mem::HasMemory
523+
[__link53]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=mem::GlobalPool
524524
[__link54]: https://docs.rs/bytes/latest/bytes/struct.Bytes.html
525-
[__link55]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesView
525+
[__link55]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesView
526526
[__link56]: https://docs.rs/bytes/latest/bytes/struct.Bytes.html
527-
[__link57]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesView
527+
[__link57]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesView
528528
[__link58]: https://docs.rs/bytes/latest/bytes/struct.Bytes.html
529529
[__link59]: https://docs.rs/bytes/latest/bytes/struct.Bytes.html
530-
[__link6]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesView::copy_to_uninit_slice
531-
[__link60]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesView
530+
[__link6]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesView::copy_to_uninit_slice
531+
[__link60]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesView
532532
[__link61]: https://doc.rust-lang.org/stable/std/?search=sync::OnceLock
533-
[__link62]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesView
534-
[__link7]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesView::as_read
535-
[__link8]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesView
536-
[__link9]: https://docs.rs/bytesbuf/0.2.1/bytesbuf/?search=BytesView::first_slice
533+
[__link62]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesView
534+
[__link7]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesView::as_read
535+
[__link8]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesView
536+
[__link9]: https://docs.rs/bytesbuf/0.2.2/bytesbuf/?search=BytesView::first_slice

crates/bytesbuf/src/lib.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@
181181
//! See `examples/bb_slice_by_slice_write.rs` for an example of how to use these methods.
182182
//!
183183
//! If you do not know exactly how much memory you need in advance, you can extend the [`BytesBuf`]
184-
//! capacity on demand by calling [`BytesBuf::reserve()`]. You can use [`remaining_capacity()`]
184+
//! capacity on demand by calling [`BytesBuf::reserve`]. You can use [`remaining_capacity()`]
185185
//! to identify how much unused memory capacity is available.
186186
//!
187187
//! ```
@@ -249,7 +249,7 @@
249249
//! ```
250250
//!
251251
//! If you already have a [`BytesView`] that you want to write into a [`BytesBuf`], call
252-
//! [`BytesBuf::put_bytes()`]. This is a highly efficient zero-copy operation
252+
//! [`BytesBuf::put_bytes`]. This is a highly efficient zero-copy operation
253253
//! that reuses the memory capacity of the view you are appending.
254254
//!
255255
//! ```

crates/data_privacy/CHANGELOG.md

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,35 @@
11
# Changelog
22

3-
## [0.10.0] - 2025-12-16
3+
## [0.10.1] - 2026-01-14
4+
5+
- 🐛 Bug Fixes
6+
7+
- Replace removed doc_auto_cfg feature with doc_cfg ([#178](https://github.com/microsoft/oxidizer/pull/178))
8+
9+
- 📚 Documentation
10+
11+
- Normalize feature handling for docs.rs ([#153](https://github.com/microsoft/oxidizer/pull/153))
12+
- Fix the CI badge ([#154](https://github.com/microsoft/oxidizer/pull/154))
13+
14+
- ✔️ Tasks
15+
16+
- Replace cargo-rdme by cargo-doc2readme ([#148](https://github.com/microsoft/oxidizer/pull/148))
17+
18+
- 🔄 Continuous Integration
19+
20+
- Add spell checker ([#158](https://github.com/microsoft/oxidizer/pull/158))
21+
22+
## [0.10.0] - 2025-12-17
423

524
- ✨ Features
625

7-
- Better serialization and perf.
26+
- Better serialization and perf. ([#133](https://github.com/microsoft/oxidizer/pull/133))
27+
28+
- 🐛 Bug Fixes
29+
30+
- Strip links in readme.md generation because cargo-rdme has problems with link comprehension ([#146](https://github.com/microsoft/oxidizer/pull/146))
31+
32+
## [0.9.0] - 2025-12-16
833

934
- 🧩 Miscellaneous
1035

@@ -73,7 +98,7 @@
7398

7499
- ✨ Features
75100

76-
- Make RedactionEngine cloneable. ([#13](https://github.com/microsoft/oxidizer/pull/13))
101+
- Make RedactionEngine clonable. ([#13](https://github.com/microsoft/oxidizer/pull/13))
77102

78103
- 📚 Documentation
79104

crates/data_privacy/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[package]
55
name = "data_privacy"
66
description = "Data annotation and redaction system providing a robust way to manipulate sensitive information."
7-
version = "0.10.0"
7+
version = "0.10.1"
88
readme = "README.md"
99
keywords = ["oxidizer", "compliance", "privacy", "redaction", "scrubbing"]
1010
categories = ["data-structures"]

crates/data_privacy/README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ How this all works:
115115
* The application uses the classified container types to wrap sensitive data throughout the application. This ensures the
116116
sensitive data is not accidentally exposed through telemetry or other means.
117117

118-
* On startup, the application initializes a [`RedactionEngine`][__link13] via [`RedactionEngine::builder()`][__link14]. The engine is configured
118+
* On startup, the application initializes a [`RedactionEngine`][__link13] via [`RedactionEngine::builder`][__link14]. The engine is configured
119119
with redactors for each data class in the taxonomy. The redactors define how to handle sensitive data for that class.
120120
For example, for a given data class, a redactor may substitute the original data for a hash value, or it may replace it with asterisks.
121121

@@ -192,19 +192,19 @@ assert_eq!(output_buffer, "********");
192192
This crate was developed as part of <a href="../..">The Oxidizer Project</a>. Browse this crate's <a href="https://github.com/microsoft/oxidizer/tree/main/crates/data_privacy">source code</a>.
193193
</sub>
194194

195-
[__cargo_doc2readme_dependencies_info]: ggGkYW0CYXSEGy4k8ldDFPOhG2VNeXtD5nnKG6EPY6OfW5wBG8g18NOFNdxpYXKEG4FOBR6whxj8G3U5pc6nDCctG_VrdEzFuyNGG1q0A9c-9HLoYWSBgmxkYXRhX3ByaXZhY3lmMC4xMC4w
196-
[__link0]: https://docs.rs/data_privacy/0.10.0/data_privacy/?search=Classified
197-
[__link1]: https://docs.rs/data_privacy/0.10.0/data_privacy/?search=Redactor
198-
[__link10]: https://docs.rs/data_privacy/0.10.0/data_privacy/?search=classified
199-
[__link11]: https://docs.rs/data_privacy/0.10.0/data_privacy/?search=taxonomy
200-
[__link12]: https://docs.rs/data_privacy/0.10.0/data_privacy/?search=classified
201-
[__link13]: https://docs.rs/data_privacy/0.10.0/data_privacy/?search=RedactionEngine
202-
[__link14]: `RedactionEngine::builder()`
203-
[__link2]: https://docs.rs/data_privacy/0.10.0/data_privacy/?search=simple_redactor::SimpleRedactor
204-
[__link3]: https://docs.rs/data_privacy/0.10.0/data_privacy/?search=Classified
205-
[__link4]: https://docs.rs/data_privacy/0.10.0/data_privacy/?search=RedactedDebug
206-
[__link5]: https://docs.rs/data_privacy/0.10.0/data_privacy/?search=RedactedDisplay
207-
[__link6]: https://docs.rs/data_privacy/0.10.0/data_privacy/?search=RedactedToString
208-
[__link7]: https://docs.rs/data_privacy/0.10.0/data_privacy/?search=taxonomy
209-
[__link8]: https://docs.rs/data_privacy/0.10.0/data_privacy/?search=DataClass
210-
[__link9]: https://docs.rs/data_privacy/0.10.0/data_privacy/?search=Classified
195+
[__cargo_doc2readme_dependencies_info]: ggGkYW0CYXSEGy4k8ldDFPOhG2VNeXtD5nnKG6EPY6OfW5wBG8g18NOFNdxpYXKEG_vJVWuNQIdLG1RbfSZVNVZ3G8Jil4LnevsRG20YH3-q9jKfYWSBgmxkYXRhX3ByaXZhY3lmMC4xMC4x
196+
[__link0]: https://docs.rs/data_privacy/0.10.1/data_privacy/?search=Classified
197+
[__link1]: https://docs.rs/data_privacy/0.10.1/data_privacy/?search=Redactor
198+
[__link10]: https://docs.rs/data_privacy/0.10.1/data_privacy/?search=classified
199+
[__link11]: https://docs.rs/data_privacy/0.10.1/data_privacy/?search=taxonomy
200+
[__link12]: https://docs.rs/data_privacy/0.10.1/data_privacy/?search=classified
201+
[__link13]: https://docs.rs/data_privacy/0.10.1/data_privacy/?search=RedactionEngine
202+
[__link14]: https://docs.rs/data_privacy/0.10.1/data_privacy/?search=RedactionEngine::builder
203+
[__link2]: https://docs.rs/data_privacy/0.10.1/data_privacy/?search=simple_redactor::SimpleRedactor
204+
[__link3]: https://docs.rs/data_privacy/0.10.1/data_privacy/?search=Classified
205+
[__link4]: https://docs.rs/data_privacy/0.10.1/data_privacy/?search=RedactedDebug
206+
[__link5]: https://docs.rs/data_privacy/0.10.1/data_privacy/?search=RedactedDisplay
207+
[__link6]: https://docs.rs/data_privacy/0.10.1/data_privacy/?search=RedactedToString
208+
[__link7]: https://docs.rs/data_privacy/0.10.1/data_privacy/?search=taxonomy
209+
[__link8]: https://docs.rs/data_privacy/0.10.1/data_privacy/?search=DataClass
210+
[__link9]: https://docs.rs/data_privacy/0.10.1/data_privacy/?search=Classified

crates/data_privacy/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@
106106
//! * The application uses the classified container types to wrap sensitive data throughout the application. This ensures the
107107
//! sensitive data is not accidentally exposed through telemetry or other means.
108108
//!
109-
//! * On startup, the application initializes a [`RedactionEngine`] via [`RedactionEngine::builder()`]. The engine is configured
109+
//! * On startup, the application initializes a [`RedactionEngine`] via [`RedactionEngine::builder`]. The engine is configured
110110
//! with redactors for each data class in the taxonomy. The redactors define how to handle sensitive data for that class.
111111
//! For example, for a given data class, a redactor may substitute the original data for a hash value, or it may replace it with asterisks.
112112
//!

0 commit comments

Comments
 (0)