feat!: make 'flush' method on encoder consume self (#79)

* makes it harder to misuse the API by calling 'flush' when chaining encoding calls by consuming the encoder when flush is called
* flush calls can no longer be retried if they fail

Author: danieleades

benches/common/mod.rs

@@ -22,7 +22,7 @@ where
     I: IntoIterator<Item = M::Symbol>,
 {
     let mut bitwriter = BitWriter::endian(Vec::new(), BigEndian);
-    let mut encoder = Encoder::new(model, &mut bitwriter);
+    let encoder = Encoder::new(model, &mut bitwriter);
 
     encoder.encode_all(input).unwrap();
     bitwriter.byte_align().unwrap();

examples/common/mod.rs

@@ -26,7 +26,7 @@ where
     I: IntoIterator<Item = M::Symbol>,
 {
     let mut bitwriter = BitWriter::endian(Vec::new(), BigEndian);
-    let mut encoder = Encoder::new(model, &mut bitwriter);
+    let encoder = Encoder::new(model, &mut bitwriter);
 
     encoder.encode_all(input).unwrap();
     bitwriter.byte_align().unwrap();

src/encoder.rs

@@ -92,7 +92,7 @@ where
     /// This method can fail if the underlying [`BitWrite`] cannot be written
     /// to.
     pub fn encode_all(
-        &mut self,
+        mut self,
         symbols: impl IntoIterator<Item = M::Symbol>,
     ) -> Result<(), Error<M::ValueError>> {
         for symbol in symbols {
@@ -138,7 +138,7 @@ where
     ///
     /// This method can fail if the underlying [`BitWrite`] cannot be written
     /// to.
-    pub fn flush(&mut self) -> io::Result<()> {
+    pub fn flush(self) -> io::Result<()> {
         self.state.flush()
     }
 
@@ -236,7 +236,7 @@ where
     /// # Errors
     ///
     /// This method can fail if the output cannot be written to
-    pub fn flush(&mut self) -> io::Result<()> {
+    pub fn flush(mut self) -> io::Result<()> {
         self.pending += 1;
         if self.state.low <= self.state.quarter() {
             self.emit(false)?;

tests/common/mod.rs

@@ -17,7 +17,7 @@ where
     M: Model,
 {
     let mut bitwriter = BitWriter::endian(Vec::new(), BigEndian);
-    let mut encoder = Encoder::new(model, &mut bitwriter);
+    let encoder = Encoder::new(model, &mut bitwriter);
 
     encoder.encode_all(input).unwrap();
     bitwriter.byte_align().unwrap();