Bond 0.9
C++ Bond Runtime Library API Documentation
Loading...
Searching...
No Matches
Bond::StdInInputStream Class Reference

A concrete implementation of StdioInputStream bound to stdin. More...

#include <bond/io/stdioinputstream.h>

Inheritance diagram for Bond::StdInInputStream:
Bond::StdioInputStream Bond::InputStream Bond::Stream

Public Member Functions

 StdInInputStream ()
 Constructs a StdInInputStream object.
virtual ~StdInInputStream ()
Public Member Functions inherited from Bond::StdioInputStream
 StdioInputStream (FILE *file)
 Constructs a StdioInputStream object.
 StdioInputStream (const char *fileName)
 Constructs a StdioInputStream object.
 StdioInputStream (StdioFileHandle &&handle)
 Constructs a StdioInputStream object.
 StdioInputStream (StdioInputStream &&other)
 Move-constructs a StdioInputStream object.
virtual ~StdioInputStream ()
 StdioInputStream (const StdioInputStream &other)=delete
StdioInputStreamoperator= (const StdioInputStream &other)=delete
StdioInputStreamoperator= (StdioInputStream &&other)
bool IsBound () const
 Tests whether this stream is currently bound to a FILE object.
virtual void Close () override
 Closes the stream.
virtual void VScan (const char *format, va_list argList) override
 Reads formatted input from the stream using a variable argument list.
virtual size_t Read (uint8_t *bytes, size_t numBytes) override
 Reads a sequence of bytes from the stream.
virtual int Read () override
 Reads a single byte from the stream.
virtual pos_t GetPosition () const override
 Returns the current position within the stream.
virtual pos_t GetEndPosition () const override
 Returns the end position of the stream.
virtual void SetPosition (off_t offset) override
 Sets the current position within the stream.
virtual void SetPositionFromEnd (off_t offset) override
 Sets the current position relative to the end of the stream.
virtual void AddOffset (off_t offset) override
 Advances the current position by the given offset.
virtual bool IsEof () const override
 Tests whether the current position is at or beyond the end of the stream.
virtual bool HasError () const override
 Tests whether the stream is currently in an error state.
virtual void ClearError () override
 Clears the current error state of the stream.
Public Member Functions inherited from Bond::InputStream
virtual ~InputStream ()
 Destroys an InputStream object.
virtual void Scan (const char *format,...)
 Reads formatted input from the stream.
size_t Read (char *bytes, size_t numBytes)
 Reads a sequence of bytes from the stream into a character buffer.
Public Member Functions inherited from Bond::Stream
virtual ~Stream ()
 Destroys a Stream object.

Additional Inherited Members

Public Types inherited from Bond::Stream
typedef long pos_t
 A type used to represent absolute positions within a stream.
typedef long off_t
 A type used to represent relative offsets within a stream.
Static Public Attributes inherited from Bond::Stream
static const int Eof = -1
 A special value returned by single-byte input functions to indicate end of stream.

Detailed Description

A concrete implementation of StdioInputStream bound to stdin.

See also
StdioInputStream

Constructor & Destructor Documentation

◆ StdInInputStream()

Bond::StdInInputStream::StdInInputStream ( )
inline

Constructs a StdInInputStream object.

◆ ~StdInInputStream()

virtual Bond::StdInInputStream::~StdInInputStream ( )
inlinevirtual

The documentation for this class was generated from the following file:
  • include/bond/io/stdioinputstream.h