GithubHelp home page GithubHelp logo

danburkert / bytekey Goto Github PK

View Code? Open in Web Editor NEW
27.0 27.0 8.0 996 KB

lexicographic sort-order preserving binary encoding

Home Page: https://crates.io/crates/bytekey

License: Apache License 2.0

Rust 100.00%

bytekey's People

Contributors

danburkert avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

bytekey's Issues

Encode variable length types in lexicographic sort ordering

Héllo,

I'm working on porting your library to GNU Guile, if I end up using your code you will be obviously cited for your work (I will attribute the bugs to myself 🎱).

So my question is the following is the lexicographic order the same for i64 and floats? If no, is it possible to come up with an algorithm that keeps all numbers (float or int) ordered. Also guile doesn't have limitations on the size of numbers do you think it's possible to build an algorithm that is limitless..?

I understand that this is a bit outside of the scope of bytekey, hopefully you have time to answer my questions.

Relicense under dual MIT/Apache-2.0

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 bytekey developers
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.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/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.

Compilation errors with recent nightly

There is various errors against nightly:

error[E0432]: unresolved import `std::iter::range_inclusive`
 --> decoder.rs:3:5
  |
3 | use std::iter::range_inclusive;
  |     ^^^^^^^^^^^^^^^^^^^^^^^^^^ no `range_inclusive` in `iter`

error[E0432]: unresolved import `std::num::wrapping`
 --> decoder.rs:5:15
  |
5 | use std::num::wrapping::OverflowingOps;
  |               ^^^^^^^^ Could not find `wrapping` in `num`

error[E0433]: failed to resolve. Could not find `Error` in `byteorder`
   --> lib.rs:149:24
    |
149 |             byteorder::Error::UnexpectedEOF => Error::UnexpectedEof,
    |                        ^^^^^ Could not find `Error` in `byteorder`

error[E0433]: failed to resolve. Could not find `Error` in `byteorder`
   --> lib.rs:150:24
    |
150 |             byteorder::Error::Io(error) => Error::Io(error),
    |                        ^^^^^ Could not find `Error` in `byteorder`

error[E0412]: cannot find type `Error` in module `byteorder`
   --> lib.rs:146:22
    |
146 | impl From<byteorder::Error> for Error {
    |                      ^^^^^ not found in `byteorder`
    |
help: possible candidates are found in other modules, you can import them into scope
    |
68  | use Error;
    |
68  | use std::error::Error;
    |
68  | use std::fmt::Error;
    |
68  | use std::io::Error;
    |

error[E0412]: cannot find type `Error` in module `byteorder`
   --> lib.rs:147:31
    |
147 |     fn from(error: byteorder::Error) -> Error {
    |                               ^^^^^ not found in `byteorder`
    |
help: possible candidates are found in other modules, you can import them into scope
    |
68  | use Error;
    |
68  | use std::error::Error;
    |
68  | use std::fmt::Error;
    |
68  | use std::io::Error;
    |

warning: unused import: `std::num::wrapping::OverflowingOps`
 --> decoder.rs:5:5
  |
5 | use std::num::wrapping::OverflowingOps;
  |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  |
  = note: #[warn(unused_imports)] on by default

error[E0599]: no method named `unwrap_or` found for type `&mut str` in the current scope
   --> encoder.rs:364:41
    |
364 |         let n = v.encode_utf8(&mut buf).unwrap_or(0);
    |                                         ^^^^^^^^^

error: aborting due to 7 previous errors

error: Could not compile `bytekey`.
warning: build failed, waiting for other jobs to finish...
error: build failed

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.