doc: remove re-exports section from crate root

Making the paths to the types private forces rustdoc to render
the structs inline in the crate root.
This is simpler to see when first reading the API doc

src/read.rs

@@ -32,31 +32,35 @@ mod ffi {
     pub const S_IFREG: u32 = 0o0100000;
 }
 
-/// ZIP archive reader
+// Put the struct declaration in a private module to convince rustdoc to display ZipArchive nicely
-///
+pub(crate) mod zip_archive {
-/// ```no_run
-/// use std::io::prelude::*;
-/// fn list_zip_contents(reader: impl Read + Seek) -> zip::result::ZipResult<()> {
-///     let mut zip = zip::ZipArchive::new(reader)?;
-///
-///     for i in 0..zip.len() {
-///         let mut file = zip.by_index(i)?;
-///         println!("Filename: {}", file.name());
-///         std::io::copy(&mut file, &mut std::io::stdout());
-///     }
-///
-///     Ok(())
-/// }
-/// ```
-#[derive(Clone, Debug)]
-pub struct ZipArchive<R> {
-    reader: R,
-    files: Vec<ZipFileData>,
-    names_map: HashMap<String, usize>,
-    offset: u64,
-    comment: Vec<u8>,
-}
 
+    /// ZIP archive reader
+    ///
+    /// ```no_run
+    /// use std::io::prelude::*;
+    /// fn list_zip_contents(reader: impl Read + Seek) -> zip::result::ZipResult<()> {
+    ///     let mut zip = zip::ZipArchive::new(reader)?;
+    ///
+    ///     for i in 0..zip.len() {
+    ///         let mut file = zip.by_index(i)?;
+    ///         println!("Filename: {}", file.name());
+    ///         std::io::copy(&mut file, &mut std::io::stdout());
+    ///     }
+    ///
+    ///     Ok(())
+    /// }
+    /// ```
+    #[derive(Clone, Debug)]
+    pub struct ZipArchive<R> {
+        pub(super) reader: R,
+        pub(super) files: Vec<super::ZipFileData>,
+        pub(super) names_map: super::HashMap<String, usize>,
+        pub(super) offset: u64,
+        pub(super) comment: Vec<u8>,
+    }
+}
+pub use zip_archive::ZipArchive;
 enum CryptoReader<'a> {
     Plaintext(io::Take<&'a mut dyn Read>),
     ZipCrypto(ZipCryptoReaderValid<io::Take<&'a mut dyn Read>>),

src/write.rs

@@ -42,45 +42,49 @@ enum GenericZipWriter<W: Write + io::Seek> {
     #[cfg(feature = "zstd")]
     Zstd(ZstdEncoder<'static, W>),
 }
-
+// Put the struct declaration in a private module to convince rustdoc to display ZipWriter nicely
-/// ZIP archive generator
+pub(crate) mod zip_writer {
-///
+    use super::*;
-/// Handles the bookkeeping involved in building an archive, and provides an
+    /// ZIP archive generator
-/// API to edit its contents.
+    ///
-///
+    /// Handles the bookkeeping involved in building an archive, and provides an
-/// ```
+    /// API to edit its contents.
-/// # fn doit() -> zip::result::ZipResult<()>
+    ///
-/// # {
+    /// ```
-/// # use zip::ZipWriter;
+    /// # fn doit() -> zip::result::ZipResult<()>
-/// use std::io::Write;
+    /// # {
-/// use zip::write::FileOptions;
+    /// # use zip::ZipWriter;
-///
+    /// use std::io::Write;
-/// // We use a buffer here, though you'd normally use a `File`
+    /// use zip::write::FileOptions;
-/// let mut buf = [0; 65536];
+    ///
-/// let mut zip = zip::ZipWriter::new(std::io::Cursor::new(&mut buf[..]));
+    /// // We use a buffer here, though you'd normally use a `File`
-///
+    /// let mut buf = [0; 65536];
-/// let options = zip::write::FileOptions::default().compression_method(zip::CompressionMethod::Stored);
+    /// let mut zip = zip::ZipWriter::new(std::io::Cursor::new(&mut buf[..]));
-/// zip.start_file("hello_world.txt", options)?;
+    ///
-/// zip.write(b"Hello, World!")?;
+    /// let options = zip::write::FileOptions::default().compression_method(zip::CompressionMethod::Stored);
-///
+    /// zip.start_file("hello_world.txt", options)?;
-/// // Apply the changes you've made.
+    /// zip.write(b"Hello, World!")?;
-/// // Dropping the `ZipWriter` will have the same effect, but may silently fail
+    ///
-/// zip.finish()?;
+    /// // Apply the changes you've made.
-///
+    /// // Dropping the `ZipWriter` will have the same effect, but may silently fail
-/// # Ok(())
+    /// zip.finish()?;
-/// # }
+    ///
-/// # doit().unwrap();
+    /// # Ok(())
-/// ```
+    /// # }
-pub struct ZipWriter<W: Write + io::Seek> {
+    /// # doit().unwrap();
-    inner: GenericZipWriter<W>,
+    /// ```
-    files: Vec<ZipFileData>,
+    pub struct ZipWriter<W: Write + io::Seek> {
-    stats: ZipWriterStats,
+        pub(super) inner: GenericZipWriter<W>,
-    writing_to_file: bool,
+        pub(super) files: Vec<ZipFileData>,
-    writing_to_extra_field: bool,
+        pub(super) stats: ZipWriterStats,
-    writing_to_central_extra_field_only: bool,
+        pub(super) writing_to_file: bool,
-    writing_raw: bool,
+        pub(super) writing_to_extra_field: bool,
-    comment: Vec<u8>,
+        pub(super) writing_to_central_extra_field_only: bool,
+        pub(super) writing_raw: bool,
+        pub(super) comment: Vec<u8>,
+    }
 }
+pub use zip_writer::ZipWriter;
 
 #[derive(Default)]
 struct ZipWriterStats {