README.md
1podio
2=====
3
4[](https://travis-ci.org/mvdnes/podio)
5[](https://ci.appveyor.com/project/mvdnes/podio/branch/master)
6[](https://crates.io/crates/podio)
7
8[Documentation](http://mvdnes.github.io/rust-docs/podio/podio/index.html)
9
10Implementation for reading and writing POD (plain old data) values in Rust. The name stands for POD I/O.
11
12Keywords: byte, be, le, big-endian, little-endian
13
14Usage
15-----
16
17Include the following code:
18
19```toml
20[dependencies]
21podio = "0.1"
22```
23
24Example
25-------
26
27```rust
28extern crate podio;
29
30use podio::{ReadPodExt, BigEndian};
31
32fn main() {
33 let slice: &[u8] = &[0x10, 0x20, 0x30, 0x40];
34 let mut reader = std::io::Cursor::new(slice);
35
36 let value = reader.read_u32::<BigEndian>().unwrap();
37
38 assert_eq!(value, 0x10203040);
39}
40```
41
42## License
43
44Licensed under either of
45
46 * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
47 * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
48
49at your option.
50
51### Contribution
52
53Unless you explicitly state otherwise, any contribution intentionally
54submitted for inclusion in the work by you, as defined in the Apache-2.0
55license, shall be dual licensed as above, without any additional terms or
56conditions.
57
){kind=link}
){kind=link}