pw::stream::Writer Class Reference

#include <stream.h>

Inheritance diagram for pw::stream::Writer:

Private Member Functions
StatusWithSize	DoRead (ByteSpan) final
	Virtual Read() function implemented by derived classes.

Friends
class	RelativeSeekableWriter
class	NonSeekableWriter

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...
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
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 }

Detailed Description

A Stream that supports writing but not reading. The Read() method is hidden.

Use in APIs when:

• Must write to, but not read from, a stream.
• May or may not need seeking. Use a SeekableWriter& if seeking is required.

Inherit from when:

• Writer cannot be extended directly. Instead, extend SeekableWriter, NonSeekableWriter, or (rarely) RelativeSeekableWriter, as appropriate.

A Writer may or may not support seeking. Check seekable() or try calling Seek() to determine if the stream is seekable.

Member Function Documentation

DoRead()

StatusWithSize pw::stream::Writer::DoRead ( ByteSpan  destination )

inlinefinalprivatevirtual

Virtual Read() function implemented by derived classes.

Implements pw::stream::Stream.

---

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

• pw_stream/public/pw_stream/stream.h