Exiv2::XPathIo Class Reference

Provides binary IO for the data from stdin and data uri path. More...

#include <basicio.hpp>

Inheritance diagram for Exiv2::XPathIo:

Public Member Functions

Creators
 XPathIo (const std::string &orgPath)
 Default constructor that reads data from stdin/data uri path and writes them to the temp file.
 
virtual ~XPathIo ()
 Destructor. Releases all managed memory and removes the temp file.
 
Manipulators
virtual void transfer (BasicIo &src)
 Change the name of the temp file and make it untemporary before calling the method of superclass FileIo::transfer.
 
- Public Member Functions inherited from Exiv2::FileIo
 FileIo (const std::string &path)
 Constructor that accepts the file path on which IO will be performed. The constructor does not open the file, and therefore never failes. More...
 
virtual ~FileIo ()
 Destructor. Flushes and closes an open file.
 
int open (const std::string &mode)
 Open the file using using the specified mode. More...
 
virtual int open ()
 Open the file using using the default access mode of "rb". This method can also be used to "reopen" a file which will flush any unwritten data and reset the IO position to the start. More...
 
virtual int close ()
 Flush and unwritten data and close the file . It is safe to call close on an already closed instance. More...
 
virtual long write (const byte *data, long wcount)
 Write data to the file. The file position is advanced by the number of bytes written. More...
 
virtual long write (BasicIo &src)
 Write data that is read from another BasicIo instance to the file. The file position is advanced by the number of bytes written. More...
 
virtual int putb (byte data)
 Write one byte to the file. The file position is advanced by one byte. More...
 
virtual DataBuf read (long rcount)
 Read data from the file. Reading starts at the current file position and the position is advanced by the number of bytes read. More...
 
virtual long read (byte *buf, long rcount)
 Read data from the file. Reading starts at the current file position and the position is advanced by the number of bytes read. More...
 
virtual int getb ()
 Read one byte from the file. The file position is advanced by one byte. More...
 
virtual int seek (long offset, Position pos)
 Move the current file position. More...
 
virtual bytemmap (bool isWriteable=false)
 Map the file into the process's address space. The file must be open before mmap() is called. If the mapped area is writeable, changes may not be written back to the underlying file until munmap() is called. The pointer is valid only as long as the FileIo object exists. More...
 
virtual int munmap ()
 Remove a mapping established with mmap(). If the mapped area is writeable, this ensures that changes are written back to the underlying file. More...
 
virtual void setPath (const std::string &path)
 close the file source and set a new path.
 
virtual long tell () const
 Get the current file position. More...
 
virtual long size () const
 Flush any buffered writes and get the current file size in bytes. More...
 
virtual bool isopen () const
 Returns true if the file is open, otherwise false.
 
virtual int error () const
 Returns 0 if the file is in a valid state, otherwise nonzero.
 
virtual bool eof () const
 Returns true if the file position has reach the end, otherwise false.
 
virtual std::string path () const
 Returns the path of the file.
 
virtual BasicIo::AutoPtr temporary () const
 Returns a temporary data storage location. The actual type returned depends upon the size of the file represented a FileIo object. For small files, a MemIo is returned while for large files a FileIo is returned. Callers should not rely on this behavior, however, since it may change. More...
 
virtual void populateFakeData ()
 Mark all the bNone blocks to bKnow. This avoids allocating memory for parts of the file that contain image-date (non-metadata/pixel data) More...
 
- Public Member Functions inherited from Exiv2::BasicIo
virtual ~BasicIo ()
 Destructor.
 

Static Public Member Functions

Static methods
static std::string writeDataToFile (const std::string &orgPath)
 Read the data from stdin/data uri path and write them to the file. More...
 

Static Public Attributes

static const std::string TEMP_FILE_EXT
 The extension of the temporary file which is created when getting input data to read metadata. This file will be deleted in destructor.
 
static const std::string GEN_FILE_EXT
 The extension of the generated file which is created when getting input data to add or modify the metadata.
 

Additional Inherited Members

- Public Types inherited from Exiv2::BasicIo
enum  Position { beg, cur, end }
 Seek starting positions.
 
typedef std::auto_ptr< BasicIoAutoPtr
 BasicIo auto_ptr type.
 
- Protected Member Functions inherited from Exiv2::BasicIo
 BasicIo ()
 Default Constructor.
 

Detailed Description

Provides binary IO for the data from stdin and data uri path.

Member Function Documentation

static std::string Exiv2::XPathIo::writeDataToFile ( const std::string &  orgPath)
static

Read the data from stdin/data uri path and write them to the file.

Parameters
orgPathIt equals "-" if the input data's from stdin. Otherwise, it's data uri path.
Returns
the name of the new file.
Exceptions
Errorif it fails.

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