Hi,
I appreciate your lib (which I use for serialization/deserialization purposes), but there is a major drawback for my use. When you read from an existing slice &[u8] you deep copy the memory in from_bytes function which is not efficient if you treat big slices. I have implemented a read-only version of your lib to handle deserialization. It would be great to have an implementation of read/write for &mut [u8] and read-only for &[u8] data containers. You would consider a contribution to your project?
Thank you,
Leo

This issue was automatically generated. Feel free to close without ceremony if
you do not agree with re-licensing or if it is not possible for other reasons.
Respond to @cmr with any questions or concerns, or pop over to
#rust-offtopic on IRC to discuss.

You're receiving this because someone (perhaps the project maintainer)
published a crates.io package with the license as "MIT" xor "Apache-2.0" and
the repository field pointing here.

TL;DR the Rust ecosystem is largely Apache-2.0. Being available under that
license is good for interoperation. The MIT license as an add-on can be nice
for GPLv2 projects to use your code.

Why?

The MIT license requires reproducing countless copies of the same copyright
header with different names in the copyright field, for every MIT library in
use. The Apache license does not have this drawback. However, this is not the
primary motivation for me creating these issues. The Apache license also has
protections from patent trolls and an explicit contribution licensing clause.
However, the Apache license is incompatible with GPLv2. This is why Rust is
dual-licensed as MIT/Apache (the "primary" license being Apache, MIT only for
GPLv2 compat), and doing so would be wise for this project. This also makes
this crate suitable for inclusion and unrestricted sharing in the Rust
standard distribution and other projects using dual MIT/Apache, such as my
personal ulterior motive, the Robigalia project.

Some ask, "Does this really apply to binary redistributions? Does MIT really
require reproducing the whole thing?" I'm not a lawyer, and I can't give legal
advice, but some Google Android apps include open source attributions using
this interpretation. Others also agree with
it.
But, again, the copyright notice redistribution is not the primary motivation
for the dual-licensing. It's stronger protections to licensees and better
interoperation with the wider Rust ecosystem.

How?

To do this, get explicit approval from each contributor of copyrightable work
(as not all contributions qualify for copyright, due to not being a "creative
work", e.g. a typo fix) and then add the following to your README:

## 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.

and in your license headers, if you have them, use the following boilerplate
(based on that used in Rust):

// Copyright 2016 rust-bytebuffer Developers
//
// Licensed under the Apache License, Version 2.0, <LICENSE-APACHE or
// http://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or
// http://opensource.org/licenses/MIT>, at your option. This file may not be
// copied, modified, or distributed except according to those terms.

It's commonly asked whether license headers are required. I'm not comfortable
making an official recommendation either way, but the Apache license
recommends it in their appendix on how to use the license.

Be sure to add the relevant LICENSE-{MIT,APACHE} files. You can copy these
from the Rust repo for a plain-text
version.

And don't forget to update the license metadata in your Cargo.toml to:

license = "MIT OR Apache-2.0"

I'll be going through projects which agree to be relicensed and have approval
by the necessary contributors and doing this changes, so feel free to leave
the heavy lifting to me!

Contributor checkoff

To agree to relicensing, comment with :

I license past and future contributions under the dual MIT/Apache-2.0 license, allowing licensees to chose either at their option.

Or, if you're a contributor, you can check the box in this repo next to your
name. My scripts will pick this exact phrase up and check your checkbox, but
I'll come through and manually review this issue later as well.

• @Terah-

I would like to use the recent changes in a separate project. Could you please publish the current state? Thanks!

As for now the bytebuffer only reads and writes in big endian order. In some cases one might actually work on the data using little endian (I'm currently facing this problem with a old archive file type). So I would consider adding a way to change the buffers order for example using a set_endian method.

When calling read_bytes etc., instead of asserting and crashing the program when overreading a buffer, I would like to seize Rusts builtin Result to signal failure. Existing code could easily adopt the new interface using calls to unwrap(). Do you think that would be a good idea? If so I can also implement it.

Hi I am trying to use bytebuffer to implement Spi communication with a target device.

While doing so I have hit the following issue.

use bytebuffer::ByteBuffer;

fn main() {
    let mut bytes = ByteBuffer::new();
    bytes.write_u8(0x2);
    bytes.write_u16(0);
    bytes.write_bits(0x4, 3);
    bytes.write_bits(7, 5);
    println!("{}", bytes.to_hex_dump());
}

The result of running this code is 0x02 0x00 0x00 0x83 0xc0.

But that is not the expected result! The result should only be 4 bytes long, not 5! The expected value would be 0x02 0x00 0x00 0x87!

So it seems to me that there is an issue with the logic of appending single bit values …

Even though this type is not in rust std, It makes it less convenient to read. Is it possible this is implemented in the future somehow?

Is it possible to specify the capacity when creating a bytebuffer to avoid frequent memory requests?