Qore Programming Language Reference Manual  0.8.12.3
Qore::InputStream Class Referenceabstract

This class defines an abstract interface for input streams. More...

Inheritance diagram for Qore::InputStream:

Public Member Functions

 constructor ()
 Constructor. More...
 
abstract *binary read (int limit)
 Reads bytes (up to a specified limit) from the input stream; returns NOTHING if there are no more bytes in the stream. More...
 

Detailed Description

This class defines an abstract interface for input streams.

Classes inheriting this class can be used to read bytes from various sources.

Since
Qore 0.8.13

Member Function Documentation

Qore::InputStream::constructor ( )

Constructor.

Used by subclasses defined in the Qore programming language.

abstract *binary Qore::InputStream::read ( int  limit)
pure virtual

Reads bytes (up to a specified limit) from the input stream; returns NOTHING if there are no more bytes in the stream.

Parameters
limitthe maximum number of bytes to read
Returns
the read bytes (the length is between 1 and `limit` inclusive) or NOTHING if no more bytes are available
Example:
1 *binary b;
2 while (b = is.read(10)) {
3  printf("Read: %y\n", b);
4 }

Implemented in Qore::StringInputStream, Qore::FileInputStream, Qore::BinaryInputStream, Qore::EncodingConversionInputStream, Qore::PipeInputStream, and Qore::TransformInputStream.