8 releases (4 breaking)

0.5.1 Jan 26, 2023
0.5.0 Sep 27, 2022
0.4.1 Aug 4, 2022
0.4.0 May 10, 2022
0.1.0 Nov 12, 2020

#13 in #cldr

Download history 8559/week @ 2022-11-29 10559/week @ 2022-12-06 8159/week @ 2022-12-13 7377/week @ 2022-12-20 6709/week @ 2022-12-27 7806/week @ 2023-01-03 9422/week @ 2023-01-10 9055/week @ 2023-01-17 9657/week @ 2023-01-24 10609/week @ 2023-01-31 13090/week @ 2023-02-07 10897/week @ 2023-02-14 11302/week @ 2023-02-21 11318/week @ 2023-02-28 10930/week @ 2023-03-07 10699/week @ 2023-03-14

45,617 downloads per month
Used in 49 crates (17 directly)

Unicode-DFS-2016

34KB
584 lines

writeable crates.io

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

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<'_>);

More Information

For more information on development, authorship, contributing etc. please visit ICU4X home page.

No runtime deps