Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
sunshowers committed Feb 1, 2024
1 parent 3868a54 commit 812b2d4
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 4 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ assert_eq!(format!("{:?}", uuid), "dffc3068-1cd6-47d5-b2f3-636b41b07084 (my_kind
## Implementations

In general, `TypedUuid` uses the same wire and serialization formats as `Uuid`. This means
that data on the wire does not change; `TypedUuid` is intended to be helpful within Rust code,
not across serialization boundaries.
that persistent representations of `TypedUuid` are the same as `Uuid`; `TypedUuid` is
intended to be helpful within Rust code, not across serialization boundaries.

- The `Display` and `FromStr` impls are forwarded to the underlying `Uuid`.
- If the `serde` feature is enabled, `TypedUuid` will serialize and deserialize using the same
Expand Down Expand Up @@ -76,6 +76,11 @@ permits conversions between typed and untyped UUIDs.
The MSRV of this crate is **Rust 1.60.** In general, this crate will follow the MSRV of the
underlying `uuid` crate.

## Alternatives

- [`typed-uuid`](https://crates.io/crates/typed-uuid): generally similar, but with a few design
decisions that are different.

## License

This project is available under the terms of either the [Apache 2.0 license](LICENSE-APACHE) or the [MIT
Expand Down
9 changes: 7 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@
//! # Implementations
//!
//! In general, [`TypedUuid`] uses the same wire and serialization formats as [`Uuid`]. This means
//! that data on the wire does not change; [`TypedUuid`] is intended to be helpful within Rust code,
//! not across serialization boundaries.
//! that persistent representations of [`TypedUuid`] are the same as [`Uuid`]; [`TypedUuid`] is
//! intended to be helpful within Rust code, not across serialization boundaries.
//!
//! - The `Display` and `FromStr` impls are forwarded to the underlying [`Uuid`].
//! - If the `serde` feature is enabled, `TypedUuid` will serialize and deserialize using the same
Expand Down Expand Up @@ -67,6 +67,11 @@
//!
//! The MSRV of this crate is **Rust 1.60.** In general, this crate will follow the MSRV of the
//! underlying `uuid` crate.
//!
//! # Alternatives
//!
//! - [`typed-uuid`](https://crates.io/crates/typed-uuid): generally similar, but with a few design
//! decisions that are different.
#![forbid(unsafe_code)]
#![warn(missing_docs)]
Expand Down

0 comments on commit 812b2d4

Please sign in to comment.