diff options
Diffstat (limited to '')
| -rw-r--r-- | third_party/rust/podio/README.md | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/third_party/rust/podio/README.md b/third_party/rust/podio/README.md new file mode 100644 index 0000000000..47c7a570ca --- /dev/null +++ b/third_party/rust/podio/README.md @@ -0,0 +1,56 @@ +podio +===== + +[](https://travis-ci.org/mvdnes/podio) +[](https://ci.appveyor.com/project/mvdnes/podio/branch/master) +[](https://crates.io/crates/podio) + +[Documentation](http://mvdnes.github.io/rust-docs/podio/podio/index.html) + +Implementation for reading and writing POD (plain old data) values in Rust. The name stands for POD I/O. + +Keywords: byte, be, le, big-endian, little-endian + +Usage +----- + +Include the following code: + +```toml +[dependencies] +podio = "0.1" +``` + +Example +------- + +```rust +extern crate podio; + +use podio::{ReadPodExt, BigEndian}; + +fn main() { + let slice: &[u8] = &[0x10, 0x20, 0x30, 0x40]; + let mut reader = std::io::Cursor::new(slice); + + let value = reader.read_u32::<BigEndian>().unwrap(); + + assert_eq!(value, 0x10203040); +} +``` + +## 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 + +Unless you explicitly state otherwise, any contribution intentionally +submitted for inclusion in the work by you, as defined in the Apache-2.0 +license, shall be dual licensed as above, without any additional terms or +conditions. |