osrs-buffer 0.7.0

A buffer for the data types in Oldschool Runescape.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

# osrs-buffer


[![Build](https://github.com/runecore/osrs-buffer/workflows/build/badge.svg)](https://github.com/runecore/osrs-buffer)
[![API](https://docs.rs/osrs-buffer/badge.svg)](https://docs.rs/osrs-buffer)
[![Crate](https://img.shields.io/crates/v/osrs-buffer)](https://crates.io/crates/osrs-buffer)
[![dependency status](https://deps.rs/repo/github/runecore/osrs-buffer/status.svg)](https://deps.rs/repo/github/runecore/osrs-buffer)
[![Discord](https://img.shields.io/discord/926860365873184768?color=5865F2)](https://discord.gg/CcTa7TZfSc)

A buffer for Oldschool Runescape data types.

## Deprecated


This crate has been deprecated in favor of [osrs-bytes](https://github.com/osrs-rs/osrs-bytes). `osrs-buffer` will not be updated anymore.

## Installation


Add this crate as a dependency to your `Cargo.toml` file.

```toml
[dependencies]
osrs-buffer = "0.7.0"
```

## Example


```rust
use osrs_buffer::{ReadExt, WriteExt};
use std::io::{self, Cursor};

fn main() -> Result<(), io::Error> {
    // Read data from the cursor
    let mut csr = Cursor::new(vec![123]);
    assert_eq!(csr.read_i8()?, 123);

    // Write data to the vector
    let mut vec = Vec::new();
    vec.write_i8(124)?;
    assert_eq!(vec[0], 124);

    Ok(())
}
```

## License


This project is licensed under the [MIT license](license-mit).

## Contributing


Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in `osrs-buffer` by you, shall be licensed as MIT, without any additional terms or conditions.