C/C++ API Reference
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Friends | List of all members
pw::protobuf::StreamDecoder::BytesReader Class Reference

Overview

stream::Reader for a bytes (or string) field in a streamed proto message.

Shares the StreamDecoder's reader, limiting it to the bounds of the field. If the StreamDecoder's reader does not support seeking, BytesReader will also not support seeking.

Warning
When a BytesReader is active, any use of the parent StreamDecoder that created it will trigger a crash. To resume using the parent decoder, destroy the BytesReader first.
Inheritance diagram for pw::protobuf::StreamDecoder::BytesReader:
pw::stream::RelativeSeekableReader pw::stream::Reader pw::stream::Stream

Public Member Functions

constexpr size_t field_size () const
 
- Public Member Functions inherited from pw::stream::Stream
constexpr bool readable () const
 
constexpr bool writable () const
 
constexpr bool seekable () const
 
constexpr bool seekable (Whence origin) const
 True if the stream supports seeking from the specified origin.
 
Result< ByteSpan > Read (ByteSpan dest)
 
Result< ByteSpan > Read (void *dest, size_t size_bytes)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
Result< ByteSpan > ReadExact (ByteSpan const buffer)
 
Status Write (ConstByteSpan data)
 
Status Write (const void *data, size_t size_bytes)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
Status Write (const std::byte b)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
Status Seek (ptrdiff_t offset, Whence origin=kBeginning)
 
size_t Tell ()
 
size_t ConservativeReadLimit () const
 
size_t ConservativeWriteLimit () const
 

Private Member Functions

StatusWithSize DoRead (ByteSpan destination) final
 Virtual Read() function implemented by derived classes.
 
Status DoSeek (ptrdiff_t offset, Whence origin) final
 Virtual Seek() function implemented by derived classes.
 

Friends

class StreamDecoder
 

Additional Inherited Members

- Public Types inherited from pw::stream::Stream
enum  Whence : uint8_t { kBeginning = 0b001 , kCurrent = 0b010 , kEnd = 0b100 }
 Positions from which to seek. More...
 
- Static Public Attributes inherited from pw::stream::Stream
static constexpr size_t kUnlimited = std::numeric_limits<size_t>::max()
 Value returned from read/write limit if unlimited.
 
static constexpr size_t kUnknownPosition = std::numeric_limits<size_t>::max()
 Returned by Tell() if getting the position is not supported.
 
- Protected Types inherited from pw::stream::Stream
enum class  LimitType : bool { kRead , kWrite }
 

Member Function Documentation

◆ DoRead()

StatusWithSize pw::protobuf::StreamDecoder::BytesReader::DoRead ( ByteSpan  destination)
finalprivatevirtual

Virtual Read() function implemented by derived classes.

Implements pw::stream::Stream.

◆ DoSeek()

Status pw::protobuf::StreamDecoder::BytesReader::DoSeek ( ptrdiff_t  offset,
Whence  origin 
)
finalprivatevirtual

Virtual Seek() function implemented by derived classes.

Implements pw::stream::Stream.

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