fix: make std::bitset formattable again

It used to be formattable via operator<<(ostream&) implicitly. Make it formattable again, but this time via formatter specialization.
fmtlib · Sep 30, 2023 · 8c3c187 · 8c3c187
1 parent 7529af8
commit 8c3c187
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/include/fmt/std.h b/include/fmt/std.h
@@ -145,6 +145,21 @@ FMT_END_NAMESPACE
 #endif
 
 FMT_BEGIN_NAMESPACE
+FMT_EXPORT
+template <std::size_t N, typename Char>
+struct formatter<std::bitset<N>, Char> : nested_formatter<string_view> {
+  template <typename FormatContext>
+  auto format(const std::bitset<N>& bs, FormatContext& ctx) const {
+    return write_padded(ctx, [&](auto out) {
+      for (auto pos = N; pos > 0; --pos) {
+        out = detail::write<Char>(out, bs[pos - 1] ? Char('1') : Char('0'));
+      }
+
+      return out;
+    });
+  }
+};
+
 FMT_EXPORT
 template <typename Char>
 struct formatter<std::thread::id, Char> : basic_ostream_formatter<Char> {};

diff --git a/test/std-test.cc b/test/std-test.cc
@@ -237,6 +237,11 @@ TEST(std_test, format_const_bit_reference) {
   EXPECT_EQ(fmt::format("{} {}", v[0], v[1]), "true false");
 }
 
+TEST(std_test, format_bitset) {
+  const std::bitset<6> bs(42);
+  EXPECT_EQ(fmt::format("{:0>8}", bs), "00101010");
+}
+
 TEST(std_test, format_atomic) {
   std::atomic<bool> b(false);
   EXPECT_EQ(fmt::format("{}", b), "false");