chore(ccitt): expose FaxImage

Author: Xiphoseer

crates/ccitt/src/g42d/decode_iter/image.rs

@@ -2,6 +2,7 @@ use std::{io, iter::Peekable};
 
 use crate::{ascii_art::BorderDrawing, ASCII};
 
+/// A decoded bi-level image
 pub struct FaxImage {
     pub(crate) width: usize,
     pub(crate) complete: Vec<bool>,
@@ -16,6 +17,7 @@ impl FaxImage {
         println!("{}", b.right);
     }
 
+    /// Print the image to the console / stdout
     pub fn print(&self, invert: bool) {
         let b = ASCII;
         self.print_border(&b.top);
@@ -30,7 +32,8 @@ impl FaxImage {
         self.print_border(&b.bottom);
     }
 
-    ///
+    /// Write a PBM file from the decoded image
+    /// 
     /// ## Parameters
     ///
     /// - `dbl` - write every line twice, because "Standard" fax is 200 dpi horizontal and 100 dpi vertical

crates/ccitt/src/g42d/mod.rs

@@ -1,16 +1,14 @@
 //! CCITT Group 4 2D-encoding
 
-use crate::{
-    bits::{BitIter, FillOrder},
-    g42d::decode_iter::FaxImage,
-};
+use crate::bits::{BitIter, FillOrder};
 
 mod decode;
 mod decode_iter;
 mod encode;
 
 pub use decode::Decoder;
 use decode_iter::FaxDecode;
+pub use decode_iter::FaxImage;
 pub use encode::Encoder;
 
 /// Options for fax decoding