Enormous, disruptive rename so we can have multiple crates. For now:

• nntp-client: all the things required to talk to a remote server
• nntp-indexer: application for taking groups and putting them in to Elasticsearch

The project does a lot of small reads in order to look for terminal characters. This code does two things to make that more efficient:

• bufstream: performs big reads to possibly reduce number of kernel calls (bufstream manages the large underlying buffer)
• NNTPLines: a rewrite of the stdlib's Lines trait, it handles finding terminal characters so we can just iterate over the lines.

Pretty big change to the library but it should reduce memory pressure and make things snappier at scale.

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

• [x] @mattnenterprise

• Convert writes to byte slices
• Replace pervasive matches with ?
• Use Result::map operator for conversions
• Reformat with "cargo +stable fmt"

Awesome crate btw! I wanted to learn more about the NNTP protocol and this is the easiest reference I have found.

This pull request was automatically generated because my scripts detected that everyone in the relicensing issue agreed to relicensing.

License headers in files were not updated, if they exist. I've reproduced an example license header below if you want to copy-paste it in. If you don't have license headers, don't feel compelled to add them.

// Copyright 2016 rust-nntp 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.

I recommend publishing a new patch version (the z in x.y.z) so that the metadata propagates to crates.io.

Please be sure to check the README.md for style. I've try to review these PRs as they go out, but I might miss something.

Thanks for relicensing!

(For my bookkeeping: this is repository id rust-nntp-efbb4f34-c501-4987-8a54-a3c5e396b5e8)

I was experimenting with this library to build an indexer.

• Async support
• Buffered IO
• TLS support
• Trying to work out how to pipeline requests
• Github actions for tests
• Indexer example which works against an Elasticsearch cluster (see the docker-compose)

I've just been merging in to my master branch so it's a big ball of changes. But I wanted to float this past you so you could see how all this is coming together.

I couldn't figure out how to recombobulate binary groups to make sense of articles so this work just kind of came to a pause

I'd like to start reading some binary newsgroups and I'm finding that the code breaks because it assumes all strings are UTF8. We should use Vec to model the incoming data.

Hi,

I was wondering if it would be a viable idea to implement a server into rust-nntp, a bit like the irc crate for Rust, which has both client and server capabilities.

WDYT?