MC Protocol Serial C++ 0.2.3
MC protocol serial library for MCU-oriented environments
Loading...
Searching...
No Matches
mcprotocol::serial::DecodeResult Struct Reference

Result returned by FrameCodec::decode_response(). More...

#include <codec.hpp>

Public Attributes

DecodeStatus status = DecodeStatus::Incomplete
 Stream-level decode status.
 
RawResponseFrame frame {}
 Raw response frame when status == DecodeStatus::Complete.
 
Status error {}
 Decoder-side error when status == DecodeStatus::Error.
 
std::size_t bytes_consumed = 0
 Number of bytes consumed from the input span.
 

Detailed Description

Result returned by FrameCodec::decode_response().

Definition at line 48 of file codec.hpp.

Member Data Documentation

◆ bytes_consumed

std::size_t mcprotocol::serial::DecodeResult::bytes_consumed = 0

Number of bytes consumed from the input span.

Definition at line 56 of file codec.hpp.

◆ error

Status mcprotocol::serial::DecodeResult::error {}

Decoder-side error when status == DecodeStatus::Error.

Definition at line 54 of file codec.hpp.

◆ frame

RawResponseFrame mcprotocol::serial::DecodeResult::frame {}

Raw response frame when status == DecodeStatus::Complete.

Definition at line 52 of file codec.hpp.

◆ status

DecodeStatus mcprotocol::serial::DecodeResult::status = DecodeStatus::Incomplete

Stream-level decode status.

Definition at line 50 of file codec.hpp.


The documentation for this struct was generated from the following file: