diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-19 00:47:55 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-19 00:47:55 +0000 |
commit | 26a029d407be480d791972afb5975cf62c9360a6 (patch) | |
tree | f435a8308119effd964b339f76abb83a57c29483 /third_party/rust/writeable/README.md | |
parent | Initial commit. (diff) | |
download | firefox-26a029d407be480d791972afb5975cf62c9360a6.tar.xz firefox-26a029d407be480d791972afb5975cf62c9360a6.zip |
Adding upstream version 124.0.1.upstream/124.0.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'third_party/rust/writeable/README.md')
-rw-r--r-- | third_party/rust/writeable/README.md | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/third_party/rust/writeable/README.md b/third_party/rust/writeable/README.md new file mode 100644 index 0000000000..c69b91cf3f --- /dev/null +++ b/third_party/rust/writeable/README.md @@ -0,0 +1,56 @@ +# writeable [![crates.io](https://img.shields.io/crates/v/writeable)](https://crates.io/crates/writeable) + +<!-- cargo-rdme start --> + +`writeable` is a utility crate of the [`ICU4X`] project. + +It includes [`Writeable`], a core trait representing an object that can be written to a +sink implementing `std::fmt::Write`. It is an alternative to `std::fmt::Display` with the +addition of a function indicating the number of bytes to be written. + +`Writeable` improves upon `std::fmt::Display` in two ways: + +1. More efficient, since the sink can pre-allocate bytes. +2. Smaller code, since the format machinery can be short-circuited. + +## Examples + +```rust +use std::fmt; +use writeable::assert_writeable_eq; +use writeable::LengthHint; +use writeable::Writeable; + +struct WelcomeMessage<'s> { + pub name: &'s str, +} + +impl<'s> Writeable for WelcomeMessage<'s> { + fn write_to<W: fmt::Write + ?Sized>(&self, sink: &mut W) -> fmt::Result { + sink.write_str("Hello, ")?; + sink.write_str(self.name)?; + sink.write_char('!')?; + Ok(()) + } + + fn writeable_length_hint(&self) -> LengthHint { + // "Hello, " + '!' + length of name + LengthHint::exact(8 + self.name.len()) + } +} + +let message = WelcomeMessage { name: "Alice" }; +assert_writeable_eq!(&message, "Hello, Alice!"); + +// Types implementing `Writeable` are recommended to also implement `fmt::Display`. +// This can be simply done by redirecting to the `Writeable` implementation: +writeable::impl_display_with_writeable!(WelcomeMessage<'_>); +``` + +[`ICU4X`]: ../icu/index.html + +<!-- cargo-rdme end --> + +## More Information + +For more information on development, authorship, contributing etc. please visit [`ICU4X home page`](https://github.com/unicode-org/icu4x). |