Skip to main content
Pigweed's logo Pigweed
code_xml
  1. Home
  2. Reference
  3. C/C++
  4. Comms
  5. pw_cobs
  6. pw::cobs::DecoderBuffer< kSizeBytes > Class Template Reference
Loading...
Searching...
No Matches
pw::cobs::DecoderBuffer< kSizeBytes > Class Template Reference

Overview

template<size_t kSizeBytes>
class pw::cobs::DecoderBuffer< kSizeBytes >

A Decoder with an inline decode buffer of kSizeBytes bytes.

Inheritance diagram for pw::cobs::DecoderBuffer< kSizeBytes >:
pw::containers::StorageBase< kAlignment, kSizeBytes > pw::cobs::Decoder

Public Member Functions

 DecoderBuffer (const DecoderBuffer &)=delete
 
DecoderBuffer & operator= (const DecoderBuffer &)=delete
 
 DecoderBuffer (DecoderBuffer &&)=delete
 
DecoderBuffer & operator= (DecoderBuffer &&)=delete
 
- Public Member Functions inherited from pw::cobs::Decoder
constexpr Decoder (ByteSpan decode_buffer)
 
void Clear ()
 Discards any partially received frame and resets the decoder to idle.
 
constexpr bool in_progress () const
 
Result< ByteSpan > Process (std::byte b)
 
template<typename Callback >
void Process (ConstByteSpan data, Callback &&callback)
 

Static Public Member Functions

static constexpr size_t max_size ()
 Returns the capacity of the decode buffer in bytes.
 

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