Pigweed
 
Loading...
Searching...
No Matches
Private Member Functions | List of all members
pw::stream::NonSeekableWriter Class Reference

#include <stream.h>

Inheritance diagram for pw::stream::NonSeekableWriter:
pw::stream::Writer pw::stream::Stream

Private Member Functions

Status DoSeek (ptrdiff_t, Whence) final
 Virtual Seek() function implemented by derived classes.
 

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 Writer that does not support seeking. The Seek() method is hidden.

Use in APIs when:

  • Do NOT use in APIs! If seeking is not required, use Writer& instead.

Inherit from when:

  • Implementing a Writer that does not support seeking.

Member Function Documentation

◆ DoSeek()

Status pw::stream::NonSeekableWriter::DoSeek ( ptrdiff_t  offset,
Whence  origin 
)
inlinefinalprivatevirtual

Virtual Seek() function implemented by derived classes.

Implements pw::stream::Stream.

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