bgzf/writer/builder: Rename Builder::build_with_writer to Builder::bu…

…ild_from_writer

noodles-bgzf/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## Unreleased
+
+### Changed
+
+  * bgzf/writer/builder: Rename `Builder::build_with_writer` to
+    `Builder::build_from_writer`.
+
+### Deprecated
+
+  * bgzf/writer/builder: Deprecate `Builder::build_with_writer`.
+
+    Use `Builder::build_from_writer` instead.
+
 ## 0.32.0 - 2024-07-14
 
 ### Added

noodles-bgzf/src/async/writer.rs

@@ -48,7 +48,7 @@ where
     /// let writer = bgzf::AsyncWriter::new(Vec::new());
     /// ```
     pub fn new(inner: W) -> Self {
-        Builder::default().build_with_writer(inner)
+        Builder::default().build_from_writer(inner)
     }
 
     /// Returns the underlying writer.

noodles-bgzf/src/async/writer/builder.rs

@@ -53,17 +53,17 @@ impl Builder {
         self
     }
 
-    /// Builds an async BGZF writer.
+    /// Builds an async BGZF writer from a writer.
     ///
     /// # Examples
     ///
     /// ```
     /// # use tokio::io;
     /// use noodles_bgzf as bgzf;
     /// let writer = bgzf::r#async::writer::Builder::default()
-    ///     .build_with_writer(io::sink());
+    ///     .build_from_writer(io::sink());
     /// ```
-    pub fn build_with_writer<W>(self, writer: W) -> Writer<W>
+    pub fn build_from_writer<W>(self, writer: W) -> Writer<W>
     where
         W: AsyncWrite,
     {
@@ -80,4 +80,13 @@ impl Builder {
             compression_level: compression_level.into(),
         }
     }
+
+    /// Builds an async BGZF writer.
+    #[deprecated(since = "0.33.0", note = "Use `Builder::build_from_writer` instead.")]
+    pub fn build_with_writer<W>(self, writer: W) -> Writer<W>
+    where
+        W: AsyncWrite,
+    {
+        self.build_from_writer(writer)
+    }
 }

noodles-bgzf/src/writer.rs

@@ -88,7 +88,7 @@ where
     /// let writer = bgzf::Writer::new(io::sink());
     /// ```
     pub fn new(inner: W) -> Self {
-        Builder::default().build_with_writer(inner)
+        Builder::default().build_from_writer(inner)
     }
 
     /// Returns a reference to the underlying writer.

noodles-bgzf/src/writer/builder.rs

@@ -33,9 +33,9 @@ impl Builder {
     /// ```
     /// # use std::io;
     /// use noodles_bgzf as bgzf;
-    /// let writer = bgzf::writer::Builder::default().build_with_writer(io::sink());
+    /// let writer = bgzf::writer::Builder::default().build_from_writer(io::sink());
     /// ```
-    pub fn build_with_writer<W>(self, writer: W) -> Writer<W>
+    pub fn build_from_writer<W>(self, writer: W) -> Writer<W>
     where
         W: Write,
     {
@@ -47,4 +47,13 @@ impl Builder {
             compression_level: self.compression_level.into(),
         }
     }
+
+    /// Builds a BGZF writer from a writer.
+    #[deprecated(since = "0.33.0", note = "Use `Builder::build_from_writer` instead.")]
+    pub fn build_with_writer<W>(self, writer: W) -> Writer<W>
+    where
+        W: Write,
+    {
+        self.build_from_writer(writer)
+    }
 }