update original

Author: funkill

rust-cookbook/CONTRIBUTING.md

@@ -157,32 +157,25 @@ crates: we decide which crates to represent in the cookbook, then come
 up with example use cases to write, then write the examples. And those
 are the three basic, recurring types of contributions needed.
 
-The development process for the cookbook today is tied to the [libz
-blitz], a broader project to improve the Rust crate ecosystem, and the
-cookbook presently represents the crates under consideration there.
-The easiest way to find the most immediate work needed for the
-cookbook is to follow the "What's next" section at the top of that
-thread, which should at all times link to something to contribute to
-the cookbook.
-
-Otherwise, look for GitHub issues with the [example] tag. The simplest
-way to contribute is to claim one of these examples, and submit a PR
-adding it. If you do claim one, please leave a comment saying so, so
-others don't accidentally duplicate your work.
+Look for GitHub issues with the [example] tag. The simplest way to
+contribute is to claim one of these examples, and submit a PR adding
+it. If you do claim one, please leave a comment saying so, so others
+don't accidentally duplicate your work.
 
 If you have an idea for an example for a specific crate, please
 suggest it on the relevant [tracking issue].
 
-Please do not submit examples for crates not yet represented in the
-cookbook, unless it is part of the libz blitz crate schedule.
-Contribution will be open to a broader set of crates in the future.
-For more about which crates are represented in the cookbook, see ["a
-note about crate representation"][which-crates] in the cookbook.
+A crate should generally only be added to the cookbook if it is the
+(or a) recommendation for its problem domain on [blessed.rs], or ranks
+at or near the top of its [crates.io] category by downloads. For more
+about which crates are represented in the cookbook, see ["a note about
+crate representation"][which-crates] in the cookbook.
 
 [example]: https://github.com/rust-lang-nursery/rust-cookbook/issues?q=is%3Aissue+is%3Aopen+label%3Aexample
 [tracking issue]: https://github.com/rust-lang-nursery/rust-cookbook/issues?q=is%3Aissue+is%3Aopen+label%3A%22tracking+issue%22
 [which-crates]: https://rust-lang-nursery.github.io/rust-cookbook/about.html#a-note-about-crate-representation
-[libz blitz]: https://internals.rust-lang.org/t/rust-libz-blitz/5184
+[blessed.rs]: https://blessed.rs
+[crates.io]: https://crates.io
 
 ## Adding an example
 

rust-cookbook/Cargo.toml

@@ -1,5 +1,5 @@
 [workspace]
-members = ["crates/algorithms/*", "crates/concurrency/*", "crates/configuration/*", "crates/development_tools/build_tools/*", "crates/development_tools/debugging/tracing", "crates/file/*", "crates/multimedia/*", "crates/parsing/*", "crates/safety_critical/*", "crates/wasm", "crates/web", "xtask"]
+members = ["crates/algorithms/*", "crates/compression/*", "crates/concurrency/*", "crates/configuration/*", "crates/development_tools/build_tools/*", "crates/development_tools/debugging/tracing", "crates/file/*", "crates/multimedia/*", "crates/parsing/*", "crates/safety_critical/*", "crates/wasm", "crates/web", "xtask"]
 exclude = ["crates/database/sea_orm", "crates/database/sqlx", "crates/multimedia/playback", "crates/web_leptos", "crates/web_leptos_hydrate", "crates/wasm_component_guest", "crates/wasm_component_host"]
 
 [workspace.package]

rust-cookbook/build.rs

@@ -15,6 +15,7 @@ const REMOVED_TESTS: &[&str] = &[
 
 const REMOVED_PREFIXES: &[&str] = &[
     "./src/algorithms/randomness/",
+    "./src/compression/bzip2/",
     "./src/configuration/",
     "./src/development_tools/build_tools/",
     "./src/development_tools/debugging/tracing/",

rust-cookbook/ci/dictionary.txt

@@ -60,6 +60,7 @@ bufwriter
 byteorder
 ByteRecord
 bytestring
+bzip
 cAFeEDEcafBAd
 CannotBeABase
 ccccff
@@ -149,6 +150,7 @@ GlobError
 graphemes
 Graphemes
 Guybrush
+gzip
 GzDecoder
 GzEncoder
 Hackerman
@@ -212,6 +214,7 @@ LazyLock
 leptos
 Leptos
 LevelFilter
+libc
 libhello
 Libz
 linux

rust-cookbook/crates/compression/bzip2/Cargo.toml

@@ -0,0 +1,10 @@
+[package]
+name = "bzip2-example"
+version.workspace = true
+authors.workspace = true
+edition.workspace = true
+license.workspace = true
+publish.workspace = true
+
+[dependencies]
+bzip2 = "0.6"

rust-cookbook/crates/compression/bzip2/src/bin/compress.rs

@@ -0,0 +1,36 @@
+use bzip2::Compression;
+use bzip2::write::BzEncoder;
+use std::fs::File;
+use std::io;
+
+fn main() -> io::Result<()> {
+    let mut input = File::open("input.txt")?;
+    let output = File::create("input.txt.bz2")?;
+    let mut encoder = BzEncoder::new(output, Compression::best());
+    io::copy(&mut input, &mut encoder)?;
+    encoder.finish()?;
+    Ok(())
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use bzip2::read::BzDecoder;
+    use std::io::{Read, Write};
+
+    #[test]
+    fn round_trips_through_bzip2() -> io::Result<()> {
+        let data = b"hello, bzip2!".repeat(100);
+
+        let mut encoder = BzEncoder::new(Vec::new(), Compression::best());
+        encoder.write_all(&data)?;
+        let compressed = encoder.finish()?;
+
+        let mut decoder = BzDecoder::new(compressed.as_slice());
+        let mut decompressed = Vec::new();
+        decoder.read_to_end(&mut decompressed)?;
+
+        assert_eq!(decompressed, data);
+        Ok(())
+    }
+}

rust-cookbook/crates/compression/bzip2/src/bin/decompress.rs

@@ -0,0 +1,35 @@
+use bzip2::read::BzDecoder;
+use std::fs::File;
+use std::io;
+
+fn main() -> io::Result<()> {
+    let input = File::open("input.txt.bz2")?;
+    let mut decoder = BzDecoder::new(input);
+    let mut output = File::create("input.txt")?;
+    io::copy(&mut decoder, &mut output)?;
+    Ok(())
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use bzip2::Compression;
+    use bzip2::write::BzEncoder;
+    use std::io::{Read, Write};
+
+    #[test]
+    fn decodes_bzip2_compressed_bytes() -> io::Result<()> {
+        let data = b"hello, bzip2!".repeat(100);
+
+        let mut encoder = BzEncoder::new(Vec::new(), Compression::best());
+        encoder.write_all(&data)?;
+        let compressed = encoder.finish()?;
+
+        let mut decoder = BzDecoder::new(compressed.as_slice());
+        let mut decompressed = Vec::new();
+        decoder.read_to_end(&mut decompressed)?;
+
+        assert_eq!(decompressed, data);
+        Ok(())
+    }
+}

rust-cookbook/src/SUMMARY.md

@@ -22,6 +22,8 @@
   - [Environment Variables](cli/env.md)
 - [Compression](compression.md)
   - [Working with Tarballs](compression/tar.md)
+  - [Working with Gzip](compression/gzip.md)
+  - [Working with Bzip2](compression/bzip2.md)
 - [Concurrency](concurrency.md)
   - [Explicit Threads](concurrency/threads.md)
   - [Synchronization Primitives](concurrency/sync.md)

rust-cookbook/src/about.md

@@ -114,19 +114,27 @@ At present the cookbook is focused on the standard library, and on
 common programming tasks, and that the rest of the ecosystem builds
 off of.
 
-The cookbook is closely tied to the [Rust Libz Blitz], a project to
-identify, and improve the quality of such crates, and so it largely
-defers crate selection to that project. Any crates that have already
-been evaluated as part of that process are in scope for the cookbook,
-as are crates that are pending evaluation.
+A crate is in scope for the cookbook if it meets one of these bars:
+
+- It is the (or a) recommendation for its problem domain on
+  [blessed.rs], a curated guide to which crate to reach for in a given
+  situation.
+- It ranks at or near the top of its [crates.io] category, sorted by
+  downloads. Category rank matters more than raw download count, since
+  aggregate downloads favor old, low-level crates (like `libc` or
+  `syn`) that aren't cookbook material on their own.
+
+Either way, the crate should also be actively maintained (a release or
+commit within the last year), have [docs.rs] documentation, and use a
+standard OSI license.
 
 {{#include links.md}}
 
 [index]: intro.html
 [error-docs]: https://doc.rust-lang.org/book/ch09-00-error-handling.html
 [error-blog]: https://brson.github.io/2016/11/30/starting-with-error-chain
 [error-chain]: https://docs.rs/error-chain/
-[Rust Libz Blitz]: https://internals.rust-lang.org/t/rust-libz-blitz/5184
+[blessed.rs]: https://blessed.rs
 [crates.io]: https://crates.io
 [docs.rs]: https://docs.rs
 [Cargo.toml]: http://doc.crates.io/manifest.html

rust-cookbook/src/compression.md

@@ -5,9 +5,17 @@
 | [Decompress a tarball][ex-tar-decompress] | [![flate2-badge]][flate2] [![tar-badge]][tar] | [![cat-compression-badge]][cat-compression] |
 | [Compress a directory into a tarball][ex-tar-compress] | [![flate2-badge]][flate2] [![tar-badge]][tar] | [![cat-compression-badge]][cat-compression] |
 | [Decompress a tarball while removing a prefix from the paths][ex-tar-strip-prefix] | [![flate2-badge]][flate2] [![tar-badge]][tar] | [![cat-compression-badge]][cat-compression] |
+| [Decompress a gzip file][ex-gzip-decompress] | [![flate2-badge]][flate2] | [![cat-compression-badge]][cat-compression] |
+| [Compress a file with gzip][ex-gzip-compress] | [![flate2-badge]][flate2] | [![cat-compression-badge]][cat-compression] |
+| [Decompress a bzip2 file][ex-bzip2-decompress] | [![bzip2-badge]][bzip2] | [![cat-compression-badge]][cat-compression] |
+| [Compress a file with bzip2][ex-bzip2-compress] | [![bzip2-badge]][bzip2] | [![cat-compression-badge]][cat-compression] |
 
 [ex-tar-decompress]: compression/tar.html#decompress-a-tarball
 [ex-tar-compress]: compression/tar.html#compress-a-directory-into-tarball
 [ex-tar-strip-prefix]: compression/tar.html#decompress-a-tarball-while-removing-a-prefix-from-the-paths
+[ex-gzip-decompress]: compression/gzip.html#decompress-a-gzip-file
+[ex-gzip-compress]: compression/gzip.html#compress-a-file-with-gzip
+[ex-bzip2-decompress]: compression/bzip2.html#decompress-a-bzip2-file
+[ex-bzip2-compress]: compression/bzip2.html#compress-a-file-with-bzip2
 
 {{#include links.md}}