4 releases (breaking)

0.4.0 Oct 26, 2024
0.3.0 Dec 10, 2023
0.2.0 Dec 9, 2023
0.1.0 Dec 6, 2023
0.0.0 Dec 6, 2023

#1196 in Rust patterns

Download history 2/week @ 2024-09-01 6/week @ 2024-09-08 1/week @ 2024-09-15 32/week @ 2024-09-22 14/week @ 2024-09-29 1/week @ 2024-10-06 5/week @ 2024-10-13 80/week @ 2024-10-20 47/week @ 2024-10-27 12/week @ 2024-11-03 10/week @ 2024-11-17 9/week @ 2024-11-24 1/week @ 2024-12-01 26/week @ 2024-12-08 16/week @ 2024-12-15

53 downloads per month
Used in 3 crates

Apache-2.0

9KB
60 lines

I/O adapters

This crate provides adapters to compose writeable traits in the standard library. The following conversions are available:

  • fmt::Write -> io::Write
  • io::Write -> hash::Hasher

Use case

Suppose you are writing a function which emits human-readable data in a zero-alloc way. The best interface looks something like this:

fn foo<Out: fmt::Write>(mut output: Out, ...) {
    // Do stuff
    writeln!(output, "My computation: {result}").unwrap();
}

Notice the use of fmt::Write: using this trait provides a type-system guarantee that the data written is valid UTF-8, hence why it should be preferred over io::Write.

Now users of this API can gather data into a String, provide their own fmt::Write implementation, etc. The problem you'll run into is if you'd like to send the output of this function to stdout: there is no built-in way to do so! That's where this crate comes in by providing an adapter, so you can write the following:

foo(&mut io::stdout().write_adapter());

No runtime deps