Go to file
David Tolnay 415ab8cf9a
Add a miri test job in CI
2021-12-10 23:06:40 -08:00
.github Add a miri test job in CI 2021-12-10 23:06:40 -08:00
benches [*.rs] rustfmt 2020-06-29 12:00:26 +10:00
src Suppress broken semicolon_if_nothing_returned lint 2021-10-04 23:50:01 -04:00
tests Remove no longer triggered string_lit_as_bytes suppression 2021-09-30 01:31:19 -04:00
.clippy.toml Inform clippy of supported compiler version in clippy.toml 2020-12-29 17:08:48 -08:00
.gitignore itoa::write 2016-06-25 14:32:23 -07:00
Cargo.toml Declare minimum Rust version in Cargo metadata 2021-10-02 01:52:37 -04:00
LICENSE-APACHE itoa::write 2016-06-25 14:32:23 -07:00
LICENSE-MIT Remove unnecessary copyright notice in MIT license 2018-07-05 13:39:29 -07:00
README.md New style of readme badges 2020-06-13 22:36:21 -07:00
performance.png Add benchmark chart 2016-06-25 14:48:22 -07:00

README.md

itoa

github crates.io docs.rs build status

This crate provides fast functions for printing integer primitives to an io::Write or a fmt::Write. The implementation comes straight from libcore but avoids the performance penalty of going through fmt::Formatter.

See also dtoa for printing floating point primitives.

Version requirement: rustc 1.0+

[dependencies]
itoa = "0.4"

Performance (lower is better)

performance


Examples

use std::{fmt, io};

fn demo_itoa_write() -> io::Result<()> {
    // Write to a vector or other io::Write.
    let mut buf = Vec::new();
    itoa::write(&mut buf, 128u64)?;
    println!("{:?}", buf);

    // Write to a stack buffer.
    let mut bytes = [0u8; 20];
    let n = itoa::write(&mut bytes[..], 128u64)?;
    println!("{:?}", &bytes[..n]);

    Ok(())
}

fn demo_itoa_fmt() -> fmt::Result {
    // Write to a string.
    let mut s = String::new();
    itoa::fmt(&mut s, 128u64)?;
    println!("{}", s);

    Ok(())
}

The function signatures are:

fn write<W: io::Write, V: itoa::Integer>(writer: W, value: V) -> io::Result<usize>;

fn fmt<W: fmt::Write, V: itoa::Integer>(writer: W, value: V) -> fmt::Result;

where itoa::Integer is implemented for i8, u8, i16, u16, i32, u32, i64, u64, i128, u128, isize and usize. 128-bit integer support requires rustc 1.26+ and the i128 feature of this crate enabled.

The write function is only available when the std feature is enabled (default is enabled). The return value gives the number of bytes written.


License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.