pw_result: Add dereference operators
Change-Id: I61a912c10377872b475f770d1e45f0c35afd0257
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/55304
Commit-Queue: Adam MacBeth <amacbeth@google.com>
Reviewed-by: Wyatt Hepler <hepler@google.com>
diff --git a/pw_result/docs.rst b/pw_result/docs.rst
index b628bbd..02c9475 100644
--- a/pw_result/docs.rst
+++ b/pw_result/docs.rst
@@ -44,6 +44,27 @@
return pw::OkStatus();
}
+``pw::Result`` can be used to directly access the contained type:
+
+.. code-block:: cpp
+
+ #include "pw_result/result.h"
+
+ pw::Result<Foo> foo = TryCreateFoo();
+ if (foo.ok()) {
+ foo->DoBar();
+ }
+
+or in C++17:
+
+.. code-block:: cpp
+
+ if (pw::Result<Foo> foo = TryCreateFoo(); foo.ok()) {
+ foo->DoBar();
+ }
+
+See `Abseil's StatusOr <https://abseil.io/tips/181>`_ for guidance on using a
+similar type.
.. warning::