csi/writer: Add common methods to access the underlying writer

zaeleus · Jun 10, 2024 · 8b3c1ac · 8b3c1ac
1 parent 3a26bdd
commit 8b3c1ac
Show file tree

Hide file tree

Showing 3 changed files with 94 additions and 14 deletions.
diff --git a/noodles-csi/CHANGELOG.md b/noodles-csi/CHANGELOG.md
@@ -4,7 +4,14 @@
 
 ### Added
 
-  * csi/reader: Add common methods to access the underlying reader.
+  * csi: Add common methods to access the underlying I/O.
+
+### Changed
+
+  * csi/async/writer: `Writer::into_inner` now returns the inner BGZF writer
+    instead of `R`.
+
+    Use `writer.into_inner().into_inner()` to unwrap into `R`.
 
 ## 0.35.0 - 2024-05-16
 

diff --git a/noodles-csi/src/async/writer.rs b/noodles-csi/src/async/writer.rs
@@ -18,22 +18,33 @@ pub struct Writer<W> {
     inner: bgzf::AsyncWriter<W>,
 }
 
-impl<W> Writer<W>
-where
-    W: AsyncWrite + Unpin,
-{
-    /// Creates an async CSI writer.
+impl<W> Writer<W> {
+    /// Returns a reference to the underlying writer.
     ///
     /// # Examples
     ///
     /// ```
     /// use noodles_csi as csi;
-    /// let writer = csi::AsyncWriter::new(Vec::new());
+    /// use tokio::io;
+    /// let writer = csi::r#async::Writer::new(io::sink());
+    /// let _inner = writer.get_ref();
     /// ```
-    pub fn new(inner: W) -> Self {
-        Self {
-            inner: bgzf::AsyncWriter::new(inner),
-        }
+    pub fn get_ref(&self) -> &bgzf::AsyncWriter<W> {
+        &self.inner
+    }
+
+    /// Returns a mutable reference to the underlying writer.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// use noodles_csi as csi;
+    /// use tokio::io;
+    /// let mut writer = csi::r#async::Writer::new(io::sink());
+    /// let _inner = writer.get_mut();
+    /// ```
+    pub fn get_mut(&mut self) -> &mut bgzf::AsyncWriter<W> {
+        &mut self.inner
     }
 
     /// Returns the underlying writer.
@@ -42,11 +53,31 @@ where
     ///
     /// ```
     /// use noodles_csi as csi;
+    /// use tokio::io;
+    /// let writer = csi::r#async::Writer::new(io::sink());
+    /// let _inner = writer.into_inner();
+    /// ```
+    pub fn into_inner(self) -> bgzf::AsyncWriter<W> {
+        self.inner
+    }
+}
+
+impl<W> Writer<W>
+where
+    W: AsyncWrite + Unpin,
+{
+    /// Creates an async CSI writer.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// use noodles_csi as csi;
     /// let writer = csi::AsyncWriter::new(Vec::new());
-    /// assert!(writer.into_inner().is_empty());
     /// ```
-    pub fn into_inner(self) -> W {
-        self.inner.into_inner()
+    pub fn new(inner: W) -> Self {
+        Self {
+            inner: bgzf::AsyncWriter::new(inner),
+        }
     }
 
     /// Shuts down the output stream.

diff --git a/noodles-csi/src/writer.rs b/noodles-csi/src/writer.rs
@@ -33,6 +33,48 @@ where
         }
     }
 
+    /// Returns a reference to the underlying writer.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// # use std::io;
+    /// use noodles_csi as csi;
+    /// let writer = csi::Writer::new(io::sink());
+    /// let _inner = writer.get_ref();
+    /// ```
+    pub fn get_ref(&self) -> &bgzf::Writer<W> {
+        &self.inner
+    }
+
+    /// Returns a mutable reference to the underlying writer.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// # use std::io;
+    /// use noodles_csi as csi;
+    /// let mut writer = csi::Writer::new(io::sink());
+    /// let _inner = writer.get_mut();
+    /// ```
+    pub fn get_mut(&mut self) -> &mut bgzf::Writer<W> {
+        &mut self.inner
+    }
+
+    /// Returns the underlying writer.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// # use std::io;
+    /// use noodles_csi as csi;
+    /// let writer = csi::Writer::new(io::sink());
+    /// let _inner = writer.into_inner();
+    /// ```
+    pub fn into_inner(self) -> bgzf::Writer<W> {
+        self.inner
+    }
+
     /// Writes a coordinate-sorted index (CSI).
     ///
     /// # Examples