Hide modules from documentation, and only export structs used in opti…

…ons or return types
shssoichiro · Jan 10, 2018 · 88f5bb0 · 88f5bb0
1 parent fe9fd95
commit 88f5bb0
Show file tree

Hide file tree

Showing 10 changed files with 148 additions and 94 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+### Version 0.18.4
+ - Bump dependencies, reduces binary size by a considerable amount
+ - Hide all modules from documentation, and only export the specific structures that should be public.
+ Previously there were too many implementation details made public. The modules are still public for the purposes of our integration tests,
+ but we strongly advice against using undocumented modules. These may become private in the future.
+
 ### Version 0.18.3
  - Return exit code of 1 if an error occurred while processing a file using the CLI app ([#93](https://github.com/shssoichiro/oxipng/issues/93))
 

diff --git a/benches/deflate.rs b/benches/deflate.rs
@@ -237,5 +237,7 @@ fn inflate_generic(b: &mut Bencher) {
     let input = test::black_box(PathBuf::from("tests/files/rgb_16_should_be_rgb_16.png"));
     let png = png::PngData::new(&input, false).unwrap();
 
-    b.iter(|| { deflate::inflate(png.idat_data.as_ref()).ok(); });
+    b.iter(|| {
+        deflate::inflate(png.idat_data.as_ref()).ok();
+    });
 }
diff --git a/benches/filters.rs b/benches/filters.rs
@@ -12,15 +12,19 @@ fn filters_16_bits_filter_0(b: &mut Bencher) {
     let input = test::black_box(PathBuf::from("tests/files/rgb_16_should_be_rgb_16.png"));
     let png = png::PngData::new(&input, false).unwrap();
 
-    b.iter(|| { png.filter_image(0); });
+    b.iter(|| {
+        png.filter_image(0);
+    });
 }
 
 #[bench]
 fn filters_8_bits_filter_0(b: &mut Bencher) {
     let input = test::black_box(PathBuf::from("tests/files/rgb_8_should_be_rgb_8.png"));
     let png = png::PngData::new(&input, false).unwrap();
 
-    b.iter(|| { png.filter_image(0); });
+    b.iter(|| {
+        png.filter_image(0);
+    });
 }
 
 #[bench]
@@ -30,7 +34,9 @@ fn filters_4_bits_filter_0(b: &mut Bencher) {
     ));
     let png = png::PngData::new(&input, false).unwrap();
 
-    b.iter(|| { png.filter_image(0); });
+    b.iter(|| {
+        png.filter_image(0);
+    });
 }
 
 #[bench]
@@ -40,7 +46,9 @@ fn filters_2_bits_filter_0(b: &mut Bencher) {
     ));
     let png = png::PngData::new(&input, false).unwrap();
 
-    b.iter(|| { png.filter_image(0); });
+    b.iter(|| {
+        png.filter_image(0);
+    });
 }
 
 #[bench]
@@ -50,23 +58,29 @@ fn filters_1_bits_filter_0(b: &mut Bencher) {
     ));
     let png = png::PngData::new(&input, false).unwrap();
 
-    b.iter(|| { png.filter_image(0); });
+    b.iter(|| {
+        png.filter_image(0);
+    });
 }
 
 #[bench]
 fn filters_16_bits_filter_1(b: &mut Bencher) {
     let input = test::black_box(PathBuf::from("tests/files/rgb_16_should_be_rgb_16.png"));
     let png = png::PngData::new(&input, false).unwrap();
 
-    b.iter(|| { png.filter_image(1); });
+    b.iter(|| {
+        png.filter_image(1);
+    });
 }
 
 #[bench]
 fn filters_8_bits_filter_1(b: &mut Bencher) {
     let input = test::black_box(PathBuf::from("tests/files/rgb_8_should_be_rgb_8.png"));
     let png = png::PngData::new(&input, false).unwrap();
 
-    b.iter(|| { png.filter_image(1); });
+    b.iter(|| {
+        png.filter_image(1);
+    });
 }
 
 #[bench]
@@ -76,7 +90,9 @@ fn filters_4_bits_filter_1(b: &mut Bencher) {
     ));
     let png = png::PngData::new(&input, false).unwrap();
 
-    b.iter(|| { png.filter_image(1); });
+    b.iter(|| {
+        png.filter_image(1);
+    });
 }
 
 #[bench]
@@ -86,7 +102,9 @@ fn filters_2_bits_filter_1(b: &mut Bencher) {
     ));
     let png = png::PngData::new(&input, false).unwrap();
 
-    b.iter(|| { png.filter_image(1); });
+    b.iter(|| {
+        png.filter_image(1);
+    });
 }
 
 #[bench]
@@ -96,23 +114,29 @@ fn filters_1_bits_filter_1(b: &mut Bencher) {
     ));
     let png = png::PngData::new(&input, false).unwrap();
 
-    b.iter(|| { png.filter_image(1); });
+    b.iter(|| {
+        png.filter_image(1);
+    });
 }
 
 #[bench]
 fn filters_16_bits_filter_2(b: &mut Bencher) {
     let input = test::black_box(PathBuf::from("tests/files/rgb_16_should_be_rgb_16.png"));
     let png = png::PngData::new(&input, false).unwrap();
 
-    b.iter(|| { png.filter_image(2); });
+    b.iter(|| {
+        png.filter_image(2);
+    });
 }
 
 #[bench]
 fn filters_8_bits_filter_2(b: &mut Bencher) {
     let input = test::black_box(PathBuf::from("tests/files/rgb_8_should_be_rgb_8.png"));
     let png = png::PngData::new(&input, false).unwrap();
 
-    b.iter(|| { png.filter_image(2); });
+    b.iter(|| {
+        png.filter_image(2);
+    });
 }
 
 #[bench]
@@ -122,7 +146,9 @@ fn filters_4_bits_filter_2(b: &mut Bencher) {
     ));
     let png = png::PngData::new(&input, false).unwrap();
 
-    b.iter(|| { png.filter_image(2); });
+    b.iter(|| {
+        png.filter_image(2);
+    });
 }
 
 #[bench]
@@ -132,7 +158,9 @@ fn filters_2_bits_filter_2(b: &mut Bencher) {
     ));
     let png = png::PngData::new(&input, false).unwrap();
 
-    b.iter(|| { png.filter_image(2); });
+    b.iter(|| {
+        png.filter_image(2);
+    });
 }
 
 #[bench]
@@ -142,23 +170,29 @@ fn filters_1_bits_filter_2(b: &mut Bencher) {
     ));
     let png = png::PngData::new(&input, false).unwrap();
 
-    b.iter(|| { png.filter_image(2); });
+    b.iter(|| {
+        png.filter_image(2);
+    });
 }
 
 #[bench]
 fn filters_16_bits_filter_3(b: &mut Bencher) {
     let input = test::black_box(PathBuf::from("tests/files/rgb_16_should_be_rgb_16.png"));
     let png = png::PngData::new(&input, false).unwrap();
 
-    b.iter(|| { png.filter_image(3); });
+    b.iter(|| {
+        png.filter_image(3);
+    });
 }
 
 #[bench]
 fn filters_8_bits_filter_3(b: &mut Bencher) {
     let input = test::black_box(PathBuf::from("tests/files/rgb_8_should_be_rgb_8.png"));
     let png = png::PngData::new(&input, false).unwrap();
 
-    b.iter(|| { png.filter_image(3); });
+    b.iter(|| {
+        png.filter_image(3);
+    });
 }
 
 #[bench]
@@ -168,7 +202,9 @@ fn filters_4_bits_filter_3(b: &mut Bencher) {
     ));
     let png = png::PngData::new(&input, false).unwrap();
 
-    b.iter(|| { png.filter_image(3); });
+    b.iter(|| {
+        png.filter_image(3);
+    });
 }
 
 #[bench]
@@ -178,7 +214,9 @@ fn filters_2_bits_filter_3(b: &mut Bencher) {
     ));
     let png = png::PngData::new(&input, false).unwrap();
 
-    b.iter(|| { png.filter_image(3); });
+    b.iter(|| {
+        png.filter_image(3);
+    });
 }
 
 #[bench]
@@ -188,23 +226,29 @@ fn filters_1_bits_filter_3(b: &mut Bencher) {
     ));
     let png = png::PngData::new(&input, false).unwrap();
 
-    b.iter(|| { png.filter_image(3); });
+    b.iter(|| {
+        png.filter_image(3);
+    });
 }
 
 #[bench]
 fn filters_16_bits_filter_4(b: &mut Bencher) {
     let input = test::black_box(PathBuf::from("tests/files/rgb_16_should_be_rgb_16.png"));
     let png = png::PngData::new(&input, false).unwrap();
 
-    b.iter(|| { png.filter_image(4); });
+    b.iter(|| {
+        png.filter_image(4);
+    });
 }
 
 #[bench]
 fn filters_8_bits_filter_4(b: &mut Bencher) {
     let input = test::black_box(PathBuf::from("tests/files/rgb_8_should_be_rgb_8.png"));
     let png = png::PngData::new(&input, false).unwrap();
 
-    b.iter(|| { png.filter_image(4); });
+    b.iter(|| {
+        png.filter_image(4);
+    });
 }
 
 #[bench]
@@ -214,7 +258,9 @@ fn filters_4_bits_filter_4(b: &mut Bencher) {
     ));
     let png = png::PngData::new(&input, false).unwrap();
 
-    b.iter(|| { png.filter_image(4); });
+    b.iter(|| {
+        png.filter_image(4);
+    });
 }
 
 #[bench]
@@ -224,7 +270,9 @@ fn filters_2_bits_filter_4(b: &mut Bencher) {
     ));
     let png = png::PngData::new(&input, false).unwrap();
 
-    b.iter(|| { png.filter_image(4); });
+    b.iter(|| {
+        png.filter_image(4);
+    });
 }
 
 #[bench]
@@ -234,23 +282,29 @@ fn filters_1_bits_filter_4(b: &mut Bencher) {
     ));
     let png = png::PngData::new(&input, false).unwrap();
 
-    b.iter(|| { png.filter_image(4); });
+    b.iter(|| {
+        png.filter_image(4);
+    });
 }
 
 #[bench]
 fn filters_16_bits_filter_5(b: &mut Bencher) {
     let input = test::black_box(PathBuf::from("tests/files/rgb_16_should_be_rgb_16.png"));
     let png = png::PngData::new(&input, false).unwrap();
 
-    b.iter(|| { png.filter_image(5); });
+    b.iter(|| {
+        png.filter_image(5);
+    });
 }
 
 #[bench]
 fn filters_8_bits_filter_5(b: &mut Bencher) {
     let input = test::black_box(PathBuf::from("tests/files/rgb_8_should_be_rgb_8.png"));
     let png = png::PngData::new(&input, false).unwrap();
 
-    b.iter(|| { png.filter_image(5); });
+    b.iter(|| {
+        png.filter_image(5);
+    });
 }
 
 #[bench]
@@ -260,7 +314,9 @@ fn filters_4_bits_filter_5(b: &mut Bencher) {
     ));
     let png = png::PngData::new(&input, false).unwrap();
 
-    b.iter(|| { png.filter_image(5); });
+    b.iter(|| {
+        png.filter_image(5);
+    });
 }
 
 #[bench]
@@ -270,7 +326,9 @@ fn filters_2_bits_filter_5(b: &mut Bencher) {
     ));
     let png = png::PngData::new(&input, false).unwrap();
 
-    b.iter(|| { png.filter_image(5); });
+    b.iter(|| {
+        png.filter_image(5);
+    });
 }
 
 #[bench]
@@ -280,5 +338,7 @@ fn filters_1_bits_filter_5(b: &mut Bencher) {
     ));
     let png = png::PngData::new(&input, false).unwrap();
 
-    b.iter(|| { png.filter_image(5); });
+    b.iter(|| {
+        png.filter_image(5);
+    });
 }
diff --git a/benches/zopfli.rs b/benches/zopfli.rs
@@ -13,15 +13,19 @@ fn zopfli_16_bits_strategy_0(b: &mut Bencher) {
     let input = test::black_box(PathBuf::from("tests/files/rgb_16_should_be_rgb_16.png"));
     let png = png::PngData::new(&input, false).unwrap();
 
-    b.iter(|| { deflate::zopfli_deflate(png.raw_data.as_ref()).ok(); });
+    b.iter(|| {
+        deflate::zopfli_deflate(png.raw_data.as_ref()).ok();
+    });
 }
 
 #[bench]
 fn zopfli_8_bits_strategy_0(b: &mut Bencher) {
     let input = test::black_box(PathBuf::from("tests/files/rgb_8_should_be_rgb_8.png"));
     let png = png::PngData::new(&input, false).unwrap();
 
-    b.iter(|| { deflate::zopfli_deflate(png.raw_data.as_ref()).ok(); });
+    b.iter(|| {
+        deflate::zopfli_deflate(png.raw_data.as_ref()).ok();
+    });
 }
 
 #[bench]
@@ -31,7 +35,9 @@ fn zopfli_4_bits_strategy_0(b: &mut Bencher) {
     ));
     let png = png::PngData::new(&input, false).unwrap();
 
-    b.iter(|| { deflate::zopfli_deflate(png.raw_data.as_ref()).ok(); });
+    b.iter(|| {
+        deflate::zopfli_deflate(png.raw_data.as_ref()).ok();
+    });
 }
 
 #[bench]
@@ -41,7 +47,9 @@ fn zopfli_2_bits_strategy_0(b: &mut Bencher) {
     ));
     let png = png::PngData::new(&input, false).unwrap();
 
-    b.iter(|| { deflate::zopfli_deflate(png.raw_data.as_ref()).ok(); });
+    b.iter(|| {
+        deflate::zopfli_deflate(png.raw_data.as_ref()).ok();
+    });
 }
 
 #[bench]
@@ -51,5 +59,7 @@ fn zopfli_1_bits_strategy_0(b: &mut Bencher) {
     ));
     let png = png::PngData::new(&input, false).unwrap();
 
-    b.iter(|| { deflate::zopfli_deflate(png.raw_data.as_ref()).ok(); });
+    b.iter(|| {
+        deflate::zopfli_deflate(png.raw_data.as_ref()).ok();
+    });
 }