Remove indent_with_len() in favor of changing the signature

Author: dralley

src/se/mod.rs

@@ -528,21 +528,18 @@ impl<'w, 'r, W: Write> Serializer<'w, 'r, W> {
     }
 
     /// Configure indent for a serializer
-    pub fn indent(&mut self, indent_char: char, indent_size: usize) -> &mut Self {
-        self.indent_with_len(indent_char, indent_size, 0)
-    }
-
-    /// Set initial indent level for a serializer
-    pub fn indent_with_len(
+    ///
+    /// Note: `initial_indent_amt` is the initial total length of the indent, not the indent level
+    pub fn indent(
         &mut self,
         indent_char: char,
         indent_size: usize,
-        indents_len: usize,
+        initial_indent_amt: usize,
     ) -> &mut Self {
         self.ser.indent = Indent::Owned(Indentation::new(
             indent_char as u8,
             indent_size,
-            indents_len,
+            initial_indent_amt,
         ));
         self
     }

src/writer.rs

@@ -361,10 +361,10 @@ impl<'a, W: Write> ElementWriter<'a, W> {
         let mut serializer = Serializer::new(ToFmtWrite(self.writer.inner()));
 
         if let Some(indent) = indent {
-            serializer.indent_with_len(
+            serializer.indent(
                 indent.indent_char as char,
                 indent.indent_size,
-                indent.indents_len,
+                indent.current_indent_len,
             );
         }
 
@@ -391,11 +391,16 @@ where
 
 #[derive(Clone)]
 pub(crate) struct Indentation {
+    /// todo: does this even belong here? It has no impact on indentation logic.
     should_line_break: bool,
+    /// The character code to be used for indentations (e.g. ` ` or `\t`)
     indent_char: u8,
+    /// How many instances of the indent character ought to be used for each level of indentation
     indent_size: usize,
+    /// Used as a cache for the bytes used for indentation
     indents: Vec<u8>,
-    indents_len: usize,
+    /// The current amount of indentation - must be less than indents.len()
+    current_indent_len: usize,
 }
 
 impl Indentation {
@@ -405,26 +410,28 @@ impl Indentation {
             indent_char,
             indent_size,
             indents: vec![indent_char; 128],
-            indents_len,
+            current_indent_len: indents_len,
         }
     }
 
     /// Increase indentation by one level
     pub fn grow(&mut self) {
-        self.indents_len += self.indent_size;
-        if self.indents_len > self.indents.len() {
-            self.indents.resize(self.indents_len, self.indent_char);
+        self.current_indent_len += self.indent_size;
+        if self.current_indent_len > self.indents.len() {
+            self.indents
+                .resize(self.current_indent_len, self.indent_char);
         }
     }
 
     /// Decrease indentation by one level. Do nothing, if level already zero
     pub fn shrink(&mut self) {
-        self.indents_len = self.indents_len.saturating_sub(self.indent_size);
+        self.current_indent_len = self.current_indent_len.saturating_sub(self.indent_size);
     }
 
     /// Returns indent string for current level
     pub fn current(&self) -> &[u8] {
-        &self.indents[..self.indents_len]
+        // todo: might be buggy if initialized > 128 without a call to grow() first
+        &self.indents[..self.current_indent_len]
     }
 }