about summary refs log tree commit diff
path: root/src/librustdoc/joined.rs
diff options
context:
space:
mode:
Diffstat (limited to 'src/librustdoc/joined.rs')
-rw-r--r--src/librustdoc/joined.rs29
1 files changed, 29 insertions, 0 deletions
diff --git a/src/librustdoc/joined.rs b/src/librustdoc/joined.rs
new file mode 100644
index 00000000000..f369c6cf237
--- /dev/null
+++ b/src/librustdoc/joined.rs
@@ -0,0 +1,29 @@
+use std::fmt::{self, Display, Formatter};
+
+pub(crate) trait Joined: IntoIterator {
+    /// Takes an iterator over elements that implement [`Display`], and format them into `f`, separated by `sep`.
+    ///
+    /// This is similar to [`Itertools::format`](itertools::Itertools::format), but instead of returning an implementation of `Display`,
+    /// it formats directly into a [`Formatter`].
+    ///
+    /// The performance of `joined` is slightly better than `format`, since it doesn't need to use a `Cell` to keep track of whether [`fmt`](Display::fmt)
+    /// was already called (`joined`'s API doesn't allow it be called more than once).
+    fn joined(self, sep: &str, f: &mut Formatter<'_>) -> fmt::Result;
+}
+
+impl<I, T> Joined for I
+where
+    I: IntoIterator<Item = T>,
+    T: Display,
+{
+    fn joined(self, sep: &str, f: &mut Formatter<'_>) -> fmt::Result {
+        let mut iter = self.into_iter();
+        let Some(first) = iter.next() else { return Ok(()) };
+        first.fmt(f)?;
+        while let Some(item) = iter.next() {
+            f.write_str(sep)?;
+            item.fmt(f)?;
+        }
+        Ok(())
+    }
+}