describe()

fl::size fl::ResetInfo::describe	(	fl::span< char >	out,
		bool	verbose = false ) const

Write a single-line human-readable description into the caller's buffer.

Returns the number of bytes written (NOT including any trailing NUL, though a NUL is appended if there is room). Truncates safely if out is too small. Never allocates. Format:

"<cause>" if subcauseId == 0 "<cause> (<sub>)" if subcauseId != 0 && !verbose "<cause> (<sub>) raw=0x<hex>" if verbose

Definition at line 68 of file watchdog.cpp.hpp.

                                                                           {
    fl::size n = 0;
    // <cause>
    n += platforms::writeView(out.subspan(n), causeName());
    // ( <sub> )  if subcauseId != 0
    if (subcauseId != 0) {
        fl::string_view sub = subcauseName();
        if (sub.size() != 0) {
            n += platforms::writeView(out.subspan(n), fl::string_view(" ("));
            n += platforms::writeView(out.subspan(n), sub);
            n += platforms::writeChar(out.subspan(n), ')');
        }
    }
    if (verbose) {
        n += platforms::writeView(out.subspan(n), fl::string_view(" raw="));
        n += platforms::writeHex(out.subspan(n), rawRegister);
    }
    return platforms::writeNulIfRoom(out, n);
}

References causeName(), FL_NOEXCEPT, rawRegister, fl::string_view::size(), subcauseId, subcauseName(), fl::platforms::writeChar(), fl::platforms::writeHex(), fl::platforms::writeNulIfRoom(), and fl::platforms::writeView().

Referenced by fl::platforms::scopedWatchdogFirstInit().

Here is the call graph for this function:

Here is the caller graph for this function: