michael/itoa
michael
/
itoa
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Revamp readme

This commit is contained in:
David Tolnay 2019-05-01 18:09:29 -07:00
parent 26dcb96645
commit 35ea54ed6b
No known key found for this signature in database
GPG Key ID: F9BA143B95FF6D82
1 changed files with 49 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
README.md
View File

@ -3,41 +3,57 @@ itoa
[![Build Status](https://api.travis-ci.org/dtolnay/itoa.svg?branch=master)](https://travis-ci.org/dtolnay/itoa)
[![Latest Version](https://img.shields.io/crates/v/itoa.svg)](https://crates.io/crates/itoa)
[![Rust Documentation](https://img.shields.io/badge/api-rustdoc-blue.svg)](https://docs.rs/itoa)
This crate provides fast functions for printing integer primitives to an
[`io::Write`](https://doc.rust-lang.org/std/io/trait.Write.html) or a
[`fmt::Write`](https://doc.rust-lang.org/core/fmt/trait.Write.html). The
implementation comes straight from
[libcore](https://github.com/rust-lang/rust/blob/b8214dc6c6fc20d0a660fb5700dca9ebf51ebe89/src/libcore/fmt/num.rs#L201-L254)
but avoids the performance penalty of going through
[`fmt::Formatter`](https://doc.rust-lang.org/std/fmt/struct.Formatter.html).
[`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`](https://github.com/dtolnay/dtoa) for printing floating point
primitives.
See also [`dtoa`] for printing floating point primitives.
[`io::Write`]: https://doc.rust-lang.org/std/io/trait.Write.html
[`fmt::Write`]: https://doc.rust-lang.org/core/fmt/trait.Write.html
[libcore]: https://github.com/rust-lang/rust/blob/b8214dc6c6fc20d0a660fb5700dca9ebf51ebe89/src/libcore/fmt/num.rs#L201-L254
[`fmt::Formatter`]: https://doc.rust-lang.org/std/fmt/struct.Formatter.html
[`dtoa`]: https://github.com/dtolnay/dtoa
```toml
[dependencies]
itoa = "0.4"
```
## Performance (lower is better)
![performance](https://raw.githubusercontent.com/dtolnay/itoa/master/performance.png)
## Functions
## Examples
```rust
extern crate itoa;
use std::{fmt, io};
// write to a vector or other io::Write
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 = [b'\0'; 20];
// Write to a stack buffer.
let mut bytes = [0u8; 20];
let n = itoa::write(&mut bytes[..], 128u64)?;
println!("{:?}", &bytes[..n]);
// write to a String
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:
@ -56,27 +72,19 @@ this crate. The return value gives the number of bytes written.
The `write` function is only available when the `std` feature is enabled
(default is enabled).
## Dependency
<br>
Itoa is available on [crates.io](https://crates.io/crates/itoa). Use the
following in `Cargo.toml`:
#### License
```toml
[dependencies]
itoa = "0.4"
```
<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>
## License
Licensed under either of
* Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.
### Contribution
<br>
<sub>
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in itoa by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.
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>