itoa/README.md

60 lines
2.0 KiB
Markdown
Raw Permalink Normal View History

2016-06-25 17:32:23 -04:00
itoa
====
2020-06-14 01:36:21 -04:00
[<img alt="github" src="https://img.shields.io/badge/github-dtolnay/itoa-8da0cb?style=for-the-badge&labelColor=555555&logo=github" height="20">](https://github.com/dtolnay/itoa)
[<img alt="crates.io" src="https://img.shields.io/crates/v/itoa.svg?style=for-the-badge&color=fc8d62&logo=rust" height="20">](https://crates.io/crates/itoa)
[<img alt="docs.rs" src="https://img.shields.io/badge/docs.rs-itoa-66c2a5?style=for-the-badge&labelColor=555555&logo=docs.rs" height="20">](https://docs.rs/itoa)
2022-12-15 20:52:40 -05:00
[<img alt="build status" src="https://img.shields.io/github/actions/workflow/status/dtolnay/itoa/ci.yml?branch=master&style=for-the-badge" height="20">](https://github.com/dtolnay/itoa/actions?query=branch%3Amaster)
2016-06-25 17:32:23 -04:00
2021-12-12 00:17:45 -05:00
This crate provides a fast conversion of integer primitives to decimal strings.
The implementation comes straight from [libcore] but avoids the performance
penalty of going through [`core::fmt::Formatter`].
2016-06-25 17:32:23 -04:00
2021-12-12 00:19:33 -05:00
See also [`ryu`] for printing floating point primitives.
2019-05-01 21:09:29 -04:00
*Version requirement: rustc 1.36+*
2019-05-01 22:04:31 -04:00
2019-05-01 21:09:29 -04:00
[libcore]: https://github.com/rust-lang/rust/blob/b8214dc6c6fc20d0a660fb5700dca9ebf51ebe89/src/libcore/fmt/num.rs#L201-L254
2021-12-12 00:17:45 -05:00
[`core::fmt::Formatter`]: https://doc.rust-lang.org/std/fmt/struct.Formatter.html
2021-12-12 00:19:33 -05:00
[`ryu`]: https://github.com/dtolnay/ryu
2019-05-01 21:09:29 -04:00
```toml
[dependencies]
2021-12-12 13:42:05 -05:00
itoa = "1.0"
2019-05-01 21:09:29 -04:00
```
2016-09-26 03:53:23 -04:00
2019-05-01 22:04:53 -04:00
<br>
## Example
2016-06-25 17:32:23 -04:00
```rust
fn main() {
let mut buffer = itoa::Buffer::new();
let printed = buffer.format(128u64);
assert_eq!(printed, "128");
2019-05-01 21:09:29 -04:00
}
2016-06-25 17:32:23 -04:00
```
2019-05-01 21:09:29 -04:00
<br>
2016-06-25 17:32:23 -04:00
2021-12-12 00:17:45 -05:00
## Performance (lower is better)
![performance](https://raw.githubusercontent.com/dtolnay/itoa/master/performance.png)
<br>
2019-05-01 21:09:29 -04:00
#### License
2016-06-25 17:32:23 -04:00
2019-05-01 21:09:29 -04:00
<sup>
Licensed under either of <a href="LICENSE-APACHE">Apache License, Version
2.0</a> or <a href="LICENSE-MIT">MIT license</a> at your option.
</sup>
2016-06-25 17:32:23 -04:00
2019-05-01 21:09:29 -04:00
<br>
2016-06-25 17:32:23 -04:00
2019-05-01 21:09:29 -04:00
<sub>
2016-06-25 17:32:23 -04:00
Unless you explicitly state otherwise, any contribution intentionally submitted
2019-05-01 21:09:29 -04:00
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.
</sub>