fasta/fai: Move writer to io module

zaeleus · Sep 23, 2024 · 44d7685 · 44d7685
1 parent 4267e32
commit 44d7685
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 12 deletions.
diff --git a/noodles-fasta/CHANGELOG.md b/noodles-fasta/CHANGELOG.md
@@ -4,13 +4,13 @@
 
 ### Changed
 
-  * fasta/fai: Move reader (`Reader`) to `io` module.
+  * fasta/fai: Move reader (`Reader`) and writer (`Writer`) to `io` module.
 
 ### Deprecated
 
-  * fasta/fai: Deprecate `Reader`.
+  * fasta/fai: Deprecate `Reader` and `Writer`.
 
-    Use `fai::io::Reader` instead.
+    Use `fai::io::Reader` and `fai::io::Writer`, respectively, instead.
 
 ## 0.43.0 - 2024-09-04
 

diff --git a/noodles-fasta/src/fai.rs b/noodles-fasta/src/fai.rs
@@ -6,13 +6,15 @@ mod r#async;
 mod index;
 pub mod io;
 mod record;
-mod writer;
 
-pub use self::{index::Index, record::Record, writer::Writer};
+pub use self::{index::Index, record::Record};
 
 #[deprecated(since = "0.44.0", note = "Use `fai::io::Reader` instead.")]
 pub use self::io::Reader;
 
+#[deprecated(since = "0.44.0", note = "Use `fai::io::Writer` instead.")]
+pub use self::io::Writer;
+
 #[cfg(feature = "async")]
 pub use self::r#async::Reader as AsyncReader;
 

diff --git a/noodles-fasta/src/fai/io.rs b/noodles-fasta/src/fai/io.rs
@@ -1,5 +1,6 @@
 //! FAI I/O.
 
 mod reader;
+mod writer;
 
-pub use self::reader::Reader;
+pub use self::{reader::Reader, writer::Writer};
diff --git a/noodles-fasta/src/fai/writer.rs → noodles-fasta/src/fai/io/writer.rs b/noodles-fasta/src/fai/writer.rs → noodles-fasta/src/fai/io/writer.rs
@@ -1,6 +1,6 @@
 use std::io::{self, Write};
 
-use super::{Index, Record};
+use crate::fai::{Index, Record};
 
 /// A FASTA index writer.
 pub struct Writer<W> {
@@ -15,7 +15,7 @@ impl<W> Writer<W> {
     /// ```
     /// # use std::io;
     /// use noodles_fasta::fai;
-    /// let writer = fai::Writer::new(io::sink());
+    /// let writer = fai::io::Writer::new(io::sink());
     /// let _inner = writer.get_ref();
     /// ```
     pub fn get_ref(&self) -> &W {
@@ -29,7 +29,7 @@ impl<W> Writer<W> {
     /// ```
     /// # use std::io;
     /// use noodles_fasta::fai;
-    /// let mut writer = fai::Writer::new(io::sink());
+    /// let mut writer = fai::io::Writer::new(io::sink());
     /// let _inner = writer.get_mut();
     /// ```
     pub fn get_mut(&mut self) -> &mut W {
@@ -43,7 +43,7 @@ impl<W> Writer<W> {
     /// ```
     /// # use std::io;
     /// use noodles_fasta::fai;
-    /// let writer = fai::Writer::new(io::sink());
+    /// let writer = fai::io::Writer::new(io::sink());
     /// let _inner = writer.into_inner();
     /// ```
     pub fn into_inner(self) -> W {
@@ -61,7 +61,7 @@ where
     ///
     /// ```
     /// use noodles_fasta::fai;
-    /// let mut writer = fai::Writer::new(Vec::new());
+    /// let mut writer = fai::io::Writer::new(Vec::new());
     /// ```
     pub fn new(inner: W) -> Self {
         Self { inner }
@@ -75,7 +75,7 @@ where
     /// # use std::io;
     /// use noodles_fasta::fai;
     ///
-    /// let mut writer = fai::Writer::new(Vec::new());
+    /// let mut writer = fai::io::Writer::new(Vec::new());
     ///
     /// let index = fai::Index::from(vec![fai::Record::new("sq0", 13, 5, 80, 81)]);
     /// writer.write_index(&index)?;