[][src]Crate bytestream

This crate provides a convenient way of reading and writing bytes to a buffer that implements the standard Read or Write traits.

Supported std types include u8, u16, u32, u64, i8, i16, i32, i64, String, Vec<T> and HashMap<T, V>.

Reading and writing of these types is done using the byteorder crate.


Add the following to your Cargo.toml file:

bytestream = "0.*"


use std::io::{Cursor, Read, Result, Write};
use bytestream::*;

#[derive(Debug, PartialEq)]
pub struct Foo {
    bar: String,
    baz: u32,

impl Streamable for Foo {
    fn read_from<R: Read>(buffer: &mut R, order: ByteOrder) -> Result<Self> {
        Ok(Self {
            bar: String::read_from(buffer, order)?,
            baz: u32::read_from(buffer, order)?,

    fn write_to<W: Write>(&self, buffer: &mut W, order: ByteOrder) -> Result<()> {
        self.bar.write_to(buffer, order)?;
        self.baz.write_to(buffer, order)?;

// Create a buffer that implements the `Write` trait
let mut buffer = Vec::<u8>::new();

// Write some data to the buffer
let foo = Foo { bar: "corgi".to_owned(), baz: 37 };
foo.write_to(&mut buffer, ByteOrder::BigEndian).unwrap();

// Read the data back from the buffer
// We wrap the buffer in a Cursor::<T> that implements the `Read` trait
let mut cursor = Cursor::new(buffer);
let other = Foo::read_from(&mut cursor, ByteOrder::BigEndian).unwrap();

assert_eq!(foo, other);

Exclude Streamable support for std types

If you do not wish to include out-of-the-box support for std types, you can exclude the default batteries-included feature in your Cargo.toml file:

bytestream = { Version = "0.*", default-features = false }

Exluding the batteries-included feature will also remove the byteorder crate dependency.


The inspiration from this crate came from the Stevenarella Minecraft client.



ByteOrder describes what order to write bytes to the buffer.



The streamable trait allows for reading and writing bytes to and from a buffer.