roo_io
API Documentation for roo_io
Loading...
Searching...
No Matches
Public Member Functions
roo_io::NullOutputStream Class Reference

#include <null_output_stream.h>

Inheritance diagram for roo_io::NullOutputStream:
[legend]
Collaboration diagram for roo_io::NullOutputStream:
[legend]

Public Member Functions

 NullOutputStream (Status error=kClosed)
 
void close () override
 Flushes and closes this stream.
 
Status status () const override
 Returns underlying stream status.
 
size_t write (const byte *buf, size_t count) override
 Attempts to write up to count bytes from buf.
 
- Public Member Functions inherited from roo_io::OutputStream
virtual ~OutputStream ()
 
bool isOpen () const
 Returns whether stream is considered open.
 
virtual size_t tryWrite (const byte *buf, size_t count)
 Attempts to write without indefinite blocking.
 
virtual size_t writeFully (const byte *buf, size_t count)
 Attempts to write count bytes from buf.
 
virtual void flush ()
 Flushes buffered data to the underlying sink.
 

Detailed Description

Definition at line 8 of file null_output_stream.h.

Constructor & Destructor Documentation

◆ NullOutputStream()

roo_io::NullOutputStream::NullOutputStream ( Status  error = kClosed)
inline

Definition at line 10 of file null_output_stream.h.

Member Function Documentation

◆ close()

void roo_io::NullOutputStream::close ( )
inlineoverridevirtual

Flushes and closes this stream.

On success, if status was kOk, status transitions to kClosed. On failure, status reflects encountered error.

Reimplemented from roo_io::OutputStream.

Definition at line 12 of file null_output_stream.h.

◆ status()

Status roo_io::NullOutputStream::status ( ) const
inlineoverridevirtual

Returns underlying stream status.

Updated by write/flush operations. Status is either kOk or an error (never kEndOfStream).

Implements roo_io::OutputStream.

Definition at line 14 of file null_output_stream.h.

◆ write()

size_t roo_io::NullOutputStream::write ( const byte *  buf,
size_t  count 
)
inlineoverridevirtual

Attempts to write up to count bytes from buf.

Updates status.

Contract:

  • On success (status() == kOk), returns at least one byte.
  • On error, may return zero or number of bytes written before failure.

If pre-call status is not kOk, call should have no effect and return zero.

Successful return does not guarantee data reached final sink until flush() succeeds.

Returns
Number of bytes written.

Implements roo_io::OutputStream.

Definition at line 16 of file null_output_stream.h.

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