chore: merge pull request #39 from threeal/error-friend-operators

Error: Declare Operators as Friend in `Error` Struct

Author: threeal

docs/error/index.rst

@@ -13,10 +13,6 @@ API Docs
 .. doxygenstruct:: error::Error
    :members:
 
-.. doxygenfunction:: error::operator==
-
-.. doxygenfunction:: error::operator!=
-
 License
 -------
 

error/.clang-format

@@ -1 +1,2 @@
 BasedOnStyle: Google
+ColumnLimit: 0

error/include/error/error.hpp

@@ -33,6 +33,40 @@ struct Error {
    * @endcode
    */
   friend std::ostream& operator<<(std::ostream& os, const error::Error& err);
+
+  /**
+   * @brief Checks if two error objects are equal.
+   * @param lhs The left-hand side error object.
+   * @param rhs The right-hand side error object.
+   * @return True if equal, false otherwise.
+   *
+   * This operator allows the comparison of two error objects using the == operator.
+   *
+   * @code{.cpp}
+   * const auto err = error::make("unknown error");
+   * const auto other_err = err;
+   *
+   * assert(err == other_err);
+   * @endcode
+   */
+  friend bool operator==(const Error& lhs, const Error& rhs);
+
+  /**
+   * @brief Checks if two error objects are not equal.
+   * @param lhs The left-hand side error object.
+   * @param rhs The right-hand side error object.
+   * @return True if not equal, false otherwise.
+   *
+   * This operator allows the comparison of two error objects using the != operator.
+   *
+   * @code{.cpp}
+   * const auto err = error::make("unknown error");
+   * const auto other_err = error::make("other error");
+   *
+   * assert(err != other_err);
+   * @endcode
+   */
+  friend bool operator!=(const Error& lhs, const Error& rhs);
 };
 
 /**
@@ -54,22 +88,6 @@ Error format(fmt::format_string<T...> fmt, T&&... args) {
   return error::make(fmt::format(fmt, std::forward<T>(args)...));
 }
 
-/**
- * @brief Checks if two error objects are equal.
- * @param lhs The left-hand side error object.
- * @param rhs The right-hand side error object.
- * @return True if equal, false otherwise.
- */
-bool operator==(const Error& lhs, const Error& rhs);
-
-/**
- * @brief Checks if two error objects are not equal.
- * @param lhs The left-hand side error object.
- * @param rhs The right-hand side error object.
- * @return True if not equal, false otherwise.
- */
-bool operator!=(const Error& lhs, const Error& rhs);
-
 }  // namespace error
 
 template <>

error/src/error.cpp

@@ -6,8 +6,6 @@ std::ostream& operator<<(std::ostream& os, const error::Error& err) {
   return os << "error: " << err.message;
 }
 
-Error make(const std::string& msg) { return Error{.message = msg}; }
-
 bool operator==(const Error& lhs, const Error& rhs) {
   return lhs.message == rhs.message;
 }
@@ -16,6 +14,8 @@ bool operator!=(const Error& lhs, const Error& rhs) {
   return lhs.message != rhs.message;
 }
 
+Error make(const std::string& msg) { return Error{.message = msg}; }
+
 }  // namespace error
 
 namespace fmt {