chore(ccitt): export G4{Encoder,Decoder}

Author: Xiphoseer

crates/ccitt/examples/ascii-art.rs

@@ -1,6 +1,6 @@
 use std::path::PathBuf;
 
-use ccitt_t4_t6::{bits::BitWriter, g42d::Decoder};
+use ccitt_t4_t6::{bits::BitWriter, g42d::G4Decoder};
 use color_eyre::eyre;
 
 #[derive(argh::FromArgs)]
@@ -26,7 +26,7 @@ fn main() -> eyre::Result<()> {
     let opt: Options = argh::from_env();
     let file = std::fs::read(&opt.file)?;
 
-    let mut decoder = Decoder::<BitWriter>::new(opt.width);
+    let mut decoder = G4Decoder::<BitWriter>::new(opt.width);
     #[cfg(feature = "debug")]
     {
         decoder.debug = opt.debug;

crates/ccitt/examples/tiffdecode.rs

@@ -5,7 +5,7 @@ use std::{
 
 use ccitt_t4_t6::{
     bits::{BitWriter, FillOrder},
-    g42d::{fax_decode, Decoder, FaxOptions},
+    g42d::{fax_decode, G4Decoder, FaxOptions},
 };
 use color_eyre::eyre::{self, eyre};
 use tiff::{
@@ -148,7 +148,7 @@ fn main() -> eyre::Result<()> {
                 }
 
                 println!("DONE fax_decode");
-                let mut decoder = Decoder::<BitWriter>::new(width.into());
+                let mut decoder = G4Decoder::<BitWriter>::new(width.into());
                 decoder.decode(&bytes)?;
                 let store = decoder.into_store();
 

crates/ccitt/src/g42d/mod.rs

@@ -1,15 +1,17 @@
-//! CCITT Group 4 2D-encoding
+//! # CCITT Group 4 2D-encoding
+//! 
+//! Spec: ITU-T Recommendation T.6 (11/88) <https://www.itu.int/rec/T-REC-T.6-198811-I/en>
 
 use crate::bits::{BitIter, FillOrder};
 
 mod decode;
 mod decode_iter;
 mod encode;
 
-pub use decode::Decoder;
+pub use decode::Decoder as G4Decoder;
 use decode_iter::FaxDecode;
 pub use decode_iter::FaxImage;
-pub use encode::Encoder;
+pub use encode::Encoder as G4Encoder;
 
 /// Options for fax decoding
 #[derive(Default)]
@@ -31,7 +33,7 @@ type FaxResult<T> = Result<T, FaxError>;
 
 /// Decode a bitmap and print it to the console
 ///
-/// **Note**: This does not use [`Decoder`]!
+/// **Note**: This does not use [`G4Decoder`]!
 pub fn fax_decode(glyph_data: &[u8], options: FaxOptions) -> FaxResult<FaxImage> {
     let mut bit_iter = BitIter::new(glyph_data);
     bit_iter.set_fill_order(options.fill_order);

crates/sdo-pdf/src/font.rs

@@ -6,7 +6,7 @@ use std::{
     str::FromStr,
 };
 
-use ccitt_t4_t6::g42d::Encoder;
+use ccitt_t4_t6::g42d::G4Encoder;
 use pdf_create::{
     common::{
         BaseEncoding, Dict, Encoding, FontDescriptor, FontFlags, Matrix, PdfString, Point,
@@ -108,7 +108,7 @@ pub fn write_char_stream<W: Write>(
     let (left_x, right_x) = hb.left_right_x();
     let box_width = right_x - left_x;
     let box_height = pchar.height as usize;
-    let mut encoder = Encoder::new(box_width, &pchar.bitmap);
+    let mut encoder = G4Encoder::new(box_width, &pchar.bitmap);
     encoder.skip_lead = hb.max_lead;
     encoder.skip_tail = hb.max_tail;
     let buf = encoder.encode();

src/cli/font/mod.rs

@@ -1,5 +1,5 @@
 use crate::cli::opt::{Format, Options};
-use ccitt_t4_t6::g42d::Encoder;
+use ccitt_t4_t6::g42d::G4Encoder;
 use color_eyre::eyre::{self, eyre};
 use eyre::Context;
 use image::ImageFormat;
@@ -82,7 +82,7 @@ fn save_as_ccitt(pset: &PSet, opt: &Options, file: &Path) -> eyre::Result<()> {
             println!("{}: {} .. {}", cval, hb.max_lead, hb.max_tail);
 
             let width = hb.bit_width();
-            let mut encoder = Encoder::new(width, &chr.bitmap);
+            let mut encoder = G4Encoder::new(width, &chr.bitmap);
             encoder.skip_lead = hb.max_lead;
             encoder.skip_tail = hb.max_tail;
             let contents = encoder.encode();