PoDoFo  1.0.0-dev
Public Member Functions | Protected Member Functions | List of all members
PoDoFo::InputStreamDevice Class Referenceabstract

This class represents an input device It optionally supports peeking. More...

#include <InputDevice.h>

Inheritance diagram for PoDoFo::InputStreamDevice:
PoDoFo::InputStream PoDoFo::PdfCanvasInputDevice PoDoFo::StreamDevice PoDoFo::NullStreamDevice

Public Member Functions

bool Peek (char &ch) const
 Peek at next char in stream. More...
 
- Public Member Functions inherited from PoDoFo::InputStream
void Read (char *buffer, size_t size)
 Read data from the device. More...
 
size_t Read (char *buffer, size_t size, bool &eof)
 Read data from the device. More...
 
char ReadChar ()
 Get next char from stream. More...
 
bool Read (char &ch)
 Get next char from stream. More...
 
void CopyTo (OutputStream &stream)
 Copy this stream to another. More...
 
void CopyTo (OutputStream &stream, size_t size)
 Copy this stream to another. More...
 

Protected Member Functions

 InputStreamDevice (bool init)
 
virtual bool peek (char &ch) const =0
 Peek at next char in stream. More...
 
void checkRead () const override
 Optional checks before reading By default does nothing.
 
- Protected Member Functions inherited from PoDoFo::InputStream
virtual size_t readBuffer (char *buffer, size_t size, bool &eof)=0
 Read a buffer from the stream /param eof true if the stream reached eof during read /returns number of read bytes.
 
virtual bool readChar (char &ch)
 Read the next char in stream. More...
 

Additional Inherited Members

- Static Protected Member Functions inherited from PoDoFo::InputStream
static size_t ReadBuffer (InputStream &stream, char *buffer, size_t size, bool &eof)
 
static bool ReadChar (InputStream &stream, char &ch)
 

Detailed Description

This class represents an input device It optionally supports peeking.

Member Function Documentation

◆ Peek()

bool InputStreamDevice::Peek ( char &  ch) const

Peek at next char in stream.

/returns true if success, false if EOF is encountered before peeking the character

◆ peek()

virtual bool PoDoFo::InputStreamDevice::peek ( char &  ch) const
protectedpure virtual

Peek at next char in stream.

/returns true if success, false if EOF

Implemented in PoDoFo::PdfCanvasInputDevice, and PoDoFo::NullStreamDevice.


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