blob: bfc37cd4a49b743bf91c402beb8e9afcd28eefb7 [file] [log] [blame]
.. _module-pw_result:
``pw::Result`` is a convenient wrapper around returning a Status along side some
data when the status is OK. This is meant for returning lightweight result
types or references to larger results.
.. warning::
Be careful not to use larger types by value as this can quickly consume
unnecessary stack.
.. warning::
This module is experimental. Its impact on code size and stack usage has not
yet been profiled. Use at your own risk.
Works with C++11, but some features require C++17.
Size report
The table below showcases the difference in size between functions returning a
Status with an output pointer, and functions returning a Result, in various
Note that these are simplified examples which do not necessarily reflect the
usage of Result in real code. Make sure to always run your own size reports to
check if Result is suitable for you.
.. include:: result_size