PoDoFo 1.2.0
Loading...
Searching...
No Matches
Protected Member Functions | Static Protected Member Functions | List of all members
PoDoFo::StreamDevice Class Reference

This class provides an output device which operates either on a file or on a buffer in memory. More...

#include <StreamDevice.h>

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

Protected Member Functions

 StreamDevice (DeviceAccess access)
 
void resetBuffers () override
 NOTE: It just forwards to InputStreamDevice, disambiguating the InputStreamDevice/OutputStreamDevice inheritance.
 
- Protected Member Functions inherited from PoDoFo::InputStreamDevice
 InputStreamDevice (bool init)
 
virtual bool peek (char &ch) const =0
 Peek at next char in stream.
 
void checkRead () const override
 Optional checks before reading By default does nothing.
 
void resetBuffers () override
 
void enableReadWindow (const char *head, const char *tail)
 Enable the inline read window over the supplied memory region.
 
void disableReadWindow ()
 Disarm the read window, handing the logical position back to the device.
 
- 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.
 
virtual bool readChar (char &ch)
 Read the next char in stream.
 

Static Protected Member Functions

static size_t SeekPosition (size_t curpos, size_t devlen, ssize_t offset, SeekDirection direction)
 
- Static Protected Member Functions inherited from PoDoFo::InputStream
static size_t ReadBuffer (InputStream &stream, char *buffer, size_t size, bool &eof)
 Read from another stream, to be used by decorator streams on their source.
 
static bool ReadChar (InputStream &stream, char &ch)
 

Additional Inherited Members

- Public Member Functions inherited from PoDoFo::InputStreamDevice
bool Peek (char &ch) const
 Peek at next char in stream.
 
- Public Member Functions inherited from PoDoFo::InputStream
void Read (char *buffer, size_t size)
 Read data from the device.
 
size_t Read (char *buffer, size_t size, bool &eof)
 Read data from the device.
 
char ReadChar ()
 Get next char from stream.
 
bool Read (char &ch)
 Get next char from stream.
 
void CopyTo (OutputStream &stream)
 Copy this stream to another.
 
void CopyTo (OutputStream &stream, size_t size)
 Copy this stream to another.
 
- Protected Attributes inherited from PoDoFo::InputStream
const char * m_head
 Inline read window over memory that already holds the bytes at the current logical position.
 
const char * m_tail
 

Detailed Description

This class provides an output device which operates either on a file or on a buffer in memory.

Additionally it can count the bytes written to the device.

This class is suitable for inheritance to provide output devices of your own. Just override the required virtual methods.


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