Add Examples.

Example  of zlip tokio write ecnoder and decoder.
Example reading zstd from stdin and write gzip to stdout, using tokio

Related to Nullus157#101

Author: CfirTsabari

Cargo.lock

@@ -61,7 +61,7 @@ futures-test = "0.3.5"
 ntest = "0.3.3"
 timebomb = "0.1.2"
 bytes = "0.5.0"
-tokio-02 = { package = "tokio", version = "0.2.21", default-features = false, features = ["io-util", "stream"] }
+tokio-02 = { package = "tokio", version = "0.2.21", default-features = false, features = ["io-util", "stream", "macros", "io-std"] }
 tokio-03 = { package = "tokio", version = "0.3.0", default-features = false, features = ["io-util", "stream"] }
 tokio-util = { version = "0.4.0", default-features = false, features = ["io"] }
 
@@ -96,3 +96,11 @@ required-features = ["zlib"]
 [[test]]
 name = "zstd"
 required-features = ["zstd"]
+
+[[example]]
+name = "zlib_tokio_02_write"
+required-features = ["zlib", "tokio-02"]
+
+[[example]]
+name = "zstd_gzip"
+required-features = ["zstd", "gzip", "tokio-02"]

Cargo.toml

@@ -0,0 +1,30 @@
+use async_compression::tokio_02::write::ZlibDecoder;
+use async_compression::tokio_02::write::ZlibEncoder;
+
+use std::io::Result;
+use tokio_02::io::AsyncWriteExt as _; // for `write_all` and `shutdown`
+
+use tokio_02 as tokio; // this enable the tokio main macro
+#[tokio_02::main]
+async fn main() -> Result<()> {
+    let data = b"example";
+    let compressed_data = compress(data).await?;
+    let de_compressed_data = decompress(&compressed_data).await?;
+    assert_eq!(de_compressed_data, data);
+    println!("{:?}", String::from_utf8(de_compressed_data).unwrap());
+    Ok(())
+}
+
+async fn compress(in_data: &[u8]) -> Result<Vec<u8>> {
+    let mut encoder = ZlibEncoder::new(Vec::new());
+    encoder.write_all(in_data).await?;
+    encoder.shutdown().await?;
+    Ok(encoder.into_inner())
+}
+
+async fn decompress(in_data: &[u8]) -> Result<Vec<u8>> {
+    let mut decoder = ZlibDecoder::new(Vec::new());
+    decoder.write_all(in_data).await?;
+    decoder.shutdown().await?;
+    Ok(decoder.into_inner())
+}

examples/zlib_tokio_02_write.rs

@@ -0,0 +1,40 @@
+use async_compression::tokio_02::bufread::ZstdDecoder;
+use async_compression::tokio_02::write::GzipEncoder;
+
+use std::io::Result;
+use tokio_02::io::stderr;
+use tokio_02::io::stdin;
+use tokio_02::io::stdout;
+use tokio_02::io::AsyncReadExt as _; // for `read_to_end`
+use tokio_02::io::AsyncWriteExt as _; // for `write_all` and `shutdown`
+use tokio_02::io::BufReader;
+
+// Run this example by running the following in the terminal:
+// ```
+// echo 'example' | zstd | cargo run --example zstd_gzip --features="all" | gunzip -c                                                                                                                                                    ─╯
+// ```
+
+use tokio_02 as tokio; // this enable the tokio main macro
+#[tokio_02::main]
+async fn main() -> Result<()> {
+    // Read zstd encoded data from stdin and decode
+    let mut reader = ZstdDecoder::new(BufReader::new(stdin()));
+    let mut x: Vec<u8> = vec![];
+    reader.read_to_end(&mut x).await?;
+
+    // print to stderr the length of the decoded data
+    let mut error = stderr();
+    error.write_all(x.len().to_string().as_bytes()).await?;
+    error.shutdown().await?;
+
+    // print to stdin encoded gzip data
+    let mut writer = GzipEncoder::new(stdout());
+    writer.write_all(&x).await?;
+    writer.shutdown().await?;
+
+    // flush stdout
+    let mut res = writer.into_inner();
+    res.flush().await?;
+
+    Ok(())
+}