Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ jobs:
- name: Install nightly toolchain for cargo-sync-rdme
uses: dtolnay/rust-toolchain@master
with:
toolchain: nightly-2025-11-05
toolchain: nightly-2026-04-30
- name: Regenerate readmes
run: just generate-readmes
- name: Check for differences
Expand Down
2 changes: 1 addition & 1 deletion Justfile
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ rustdoc *args:

# Generate README.md using `cargo-sync-rdme`.
generate-readmes:
cargo sync-rdme --toolchain nightly-2025-11-05 --all-features
cargo sync-rdme --toolchain nightly-2026-04-30 --all-features

# Run cargo release in CI.
ci-cargo-release:
Expand Down
21 changes: 12 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ Newtype wrappers for byte arrays and vectors with hex and base64
formatting.

This crate provides wrapper types that display byte data in
human-readable encodings. [`HexArray<N>`](https://docs.rs/byte-wrapper/0.1.0/byte_wrapper/hex_array/struct.HexArray.html) encodes fixed-length byte
arrays as hex strings, and [`Base64Vec`](https://docs.rs/byte-wrapper/0.1.0/byte_wrapper/base64_vec/struct.Base64Vec.html) encodes variable-length
human-readable encodings. [`HexArray<N>`] encodes fixed-length byte
arrays as hex strings, and [`Base64Vec`] encodes variable-length
byte vectors as base64 strings.

With the `serde` feature, both types implement `Serialize` and
Expand All @@ -31,9 +31,9 @@ including automatic opt-in replacement with

## Types

* [`HexArray<N>`](https://docs.rs/byte-wrapper/0.1.0/byte_wrapper/hex_array/struct.HexArray.html) encodes a fixed-length byte array as a hex
* [`HexArray<N>`] encodes a fixed-length byte array as a hex
string. (Requires the `hex` feature.)
* [`Base64Vec`](https://docs.rs/byte-wrapper/0.1.0/byte_wrapper/base64_vec/struct.Base64Vec.html) encodes a variable-length byte vector as a base64
* [`Base64Vec`] encodes a variable-length byte vector as a base64
string. (Requires the `base64` feature.)

## Examples
Expand Down Expand Up @@ -106,15 +106,17 @@ The closest alternatives are:

## Features

* **`hex`**: enables [`HexArray`](https://docs.rs/byte-wrapper/0.1.0/byte_wrapper/hex_array/struct.HexArray.html). *Enabled by default.*
* **`base64`**: enables [`Base64Vec`](https://docs.rs/byte-wrapper/0.1.0/byte_wrapper/base64_vec/struct.Base64Vec.html) (implies `alloc`).
* **`hex`**: enables [`HexArray`]. *Enabled by default.*
* **`base64`**: enables [`Base64Vec`] (implies `alloc`).
*Enabled by default.*
* **`alloc`**: enables `alloc` support (required by `base64`).
* **`serde`**: implements `Serialize` and `Deserialize` for
enabled types. *Not enabled by default.*
* **`schemars08`**: derives `JsonSchema` for enabled types.
*Not enabled by default.*

[`HexArray<N>`]: https://docs.rs/byte-wrapper/0.1.0/byte_wrapper/hex_array/struct.HexArray.html "struct byte_wrapper::hex_array::HexArray"
[`Base64Vec`]: https://docs.rs/byte-wrapper/0.1.0/byte_wrapper/base64_vec/struct.Base64Vec.html "struct byte_wrapper::base64_vec::Base64Vec"
[CBOR]: https://cbor.io/
[`JsonSchema`]: https://docs.rs/schemars/0.8/schemars/trait.JsonSchema.html
[`serde-human-bytes`]: https://docs.rs/serde-human-bytes
Expand All @@ -124,9 +126,10 @@ The closest alternatives are:
[`hexutil`]: https://docs.rs/hexutil
[`serde-bytes-repr`]: https://docs.rs/serde-bytes-repr
[`is_human_readable()`]: https://docs.rs/serde/latest/serde/trait.Serializer.html#method.is_human_readable
[`Display`]: https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html
[`FromStr`]: https://doc.rust-lang.org/nightly/core/str/traits/trait.FromStr.html
[`Deref`]: https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html
[`Display`]: https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html "trait core::fmt::Display"
[`FromStr`]: https://doc.rust-lang.org/nightly/core/str/traits/trait.FromStr.html "trait core::str::traits::FromStr"
[`Deref`]: https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html "trait core::ops::deref::Deref"
[`HexArray`]: https://docs.rs/byte-wrapper/0.1.0/byte_wrapper/hex_array/struct.HexArray.html "struct byte_wrapper::hex_array::HexArray"
<!-- cargo-sync-rdme ]] -->

## License
Expand Down
Loading