Switch the Baton template params
[folly.git] / folly / Format.h
index d6fd2ff0c3a038d69da6783415aeda89f355b328..b8df86fbfa1e8d02c54251011ea3b570df62e892 100644 (file)
@@ -18,6 +18,7 @@
 #define FOLLY_FORMAT_H_
 
 #include <cstdio>
+#include <stdexcept>
 #include <tuple>
 #include <type_traits>
 
@@ -46,7 +47,7 @@ class FormatValue;
 // meta-attribute to identify formatters in this sea of template weirdness
 namespace detail {
 class FormatterTag {};
-};
+} // namespace detail
 
 /**
  * Formatter class.
@@ -306,6 +307,33 @@ inline std::string svformat(StringPiece fmt, Container&& container) {
   return vformat(fmt, std::forward<Container>(container)).str();
 }
 
+/**
+ * Exception class thrown when a format key is not found in the given
+ * associative container keyed by strings. We inherit std::out_of_range for
+ * compatibility with callers that expect exception to be thrown directly
+ * by std::map or std::unordered_map.
+ *
+ * Having the key be at the end of the message string, we can access it by
+ * simply adding its offset to what(). Not storing separate std::string key
+ * makes the exception type small and noexcept-copyable like std::out_of_range,
+ * and therefore able to fit in-situ in exception_wrapper.
+ */
+class FormatKeyNotFoundException : public std::out_of_range {
+ public:
+  explicit FormatKeyNotFoundException(StringPiece key);
+
+  char const* key() const noexcept {
+    return what() + kMessagePrefix.size();
+  }
+
+ private:
+  static constexpr StringPiece const kMessagePrefix = "format key not found: ";
+};
+
+namespace detail {
+[[noreturn]] void throwFormatKeyNotFoundException(StringPiece key);
+} // namespace detail
+
 /**
  * Wrap a sequence or associative container so that out-of-range lookups
  * return a default value rather than throwing an exception.
@@ -322,7 +350,7 @@ struct DefaultValueWrapper {
   const Container& container;
   const Value& defaultValue;
 };
-} // namespace
+} // namespace detail
 
 template <class Container, class Value>
 detail::DefaultValueWrapper<Container, Value> defaulted(
@@ -432,7 +460,7 @@ struct IsFormatter<
     typename std::enable_if<
         std::is_same<typename T::IsFormatter, detail::FormatterTag>::value>::
         type> : public std::true_type {};
-} // folly::detail
+} // namespace detail
 
 // Deprecated API. formatChecked() et. al. now behave identically to their
 // non-Checked counterparts.