copyTo()

fl::result< u32, DecodeError > fl::channels::rx::Ws2812StreamDecoder::copyTo

(

fl::span< u8 >

out

)

const

Copy the decoded frame into out with the batch decoder's result rules (overflow, >10% error rate, partial final byte).

Call after finish().

Definition at line 300 of file ws2812_stream_decoder.cpp.hpp.

                                                                                        {
    if (mStats.overrun) {
        return fl::result<u32, DecodeError>::failure(DecodeError::CAPTURE_OVERRUN);
    }
    if (mStats.gapBitShift) {
        // The capture-time timing kept or dropped a gap bit that the decode
        // timing would not: every later bit is shifted. Pass the decode
        // timing as RxConfig::stream_timing.
        return fl::result<u32, DecodeError>::failure(DecodeError::INVALID_ARGUMENT);
    }
    if (mStats.pairs == 0 || out.size() == 0) {
        return fl::result<u32, DecodeError>::success(0);
    }
    const u32 full = mStats.fullBytes;
    if (full > out.size() || full > mOut.size()) {
        return fl::result<u32, DecodeError>::failure(DecodeError::BUFFER_OVERFLOW);
    }
    u32 n = full;
    if (mPartialWritten && n < out.size()) {
        ++n;
    }
    for (u32 k = 0; k < n; ++k) {
        out[k] = mOut[k];
    }
    if (mStats.bits > 0 && (mStats.errors * 10) > mStats.bits) {
        return fl::result<u32, DecodeError>::failure(DecodeError::HIGH_ERROR_RATE);
    }
    return fl::result<u32, DecodeError>::success(n);
}

References fl::BUFFER_OVERFLOW, fl::CAPTURE_OVERRUN, fl::expected< T, E >::failure(), fl::FL_NO_EXCEPT, fl::HIGH_ERROR_RATE, fl::INVALID_ARGUMENT, mOut, mPartialWritten, mStats, and fl::expected< T, E >::success().

Here is the call graph for this function: