logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

zipios::ZipOutputStreambuf - ZipOutputStreambuf is a zip output streambuf filter.

Author

       Generated automatically by Doxygen for Zipios++ from the source code.

Zipios++                                         Tue Mar 24 2020                   zipios::ZipOutputStreambuf(3)

Constructor & Destructor Documentation

zipios::ZipOutputStreambuf::ZipOutputStreambuf(streambuf*outbuf,booldel_outbuf=false)[explicit]ZipOutputStreambuf constructor. A newly constructed ZipOutputStreambuf is not ready to accept data,
       putNextEntry() must be invoked first.

       Parametersoutbuf the streambuf to use for input.
           del_outbuf if true is specified outbuf will be deleted, when the ZipOutputStreambuf is destructed.

       Definition at line 20 of file zipoutputstreambuf.cpp.

   zipios::ZipOutputStreambuf::~ZipOutputStreambuf()[virtual]
       Destructor.

       Definition at line 56 of file zipoutputstreambuf.cpp.

Detailed Description

ZipOutputStreambuf is a zip output streambuf filter.

       Definition at line 17 of file zipoutputstreambuf.h.

Member Function Documentation

voidzipios::ZipOutputStreambuf::close()
       Calls finish.

       Definition at line 41 of file zipoutputstreambuf.cpp.

   voidzipios::ZipOutputStreambuf::closeEntry()
       Closes the current entry, and positions the stream read pointer at the beginning of the next entry (if
       there is one).

       Definition at line 30 of file zipoutputstreambuf.cpp.

   voidzipios::ZipOutputStreambuf::finish()
       Closes the current entry (if one is open), then writes the Zip Central Directory Structure closing the
       ZipOutputStream. The output stream that the zip archive is being written to is not closed.

       Definition at line 46 of file zipoutputstreambuf.cpp.

   voidzipios::ZipOutputStreambuf::putNextEntry(constZipCDirEntry&entry)
       Begins writing the next entry. Opens the next entry in the zip archive and returns a const pointer to a
       FileEntry object for the entry.

       Returns
           a const FileEntry * containing information about the (now) current entry.

       Definition at line 61 of file zipoutputstreambuf.cpp.

   voidzipios::ZipOutputStreambuf::setComment(conststring&comment)
       Sets the global comment for the Zip archive.

       Definition at line 83 of file zipoutputstreambuf.cpp.

   voidzipios::ZipOutputStreambuf::setLevel(intlevel)
       Sets the compression level to be used for subsequent entries.

       Definition at line 88 of file zipoutputstreambuf.cpp.

   voidzipios::ZipOutputStreambuf::setMethod(StorageMethodmethod)
       Sets the compression method to be used. only STORED and DEFLATED are supported.

       Definition at line 93 of file zipoutputstreambuf.cpp.

Name

       zipios::ZipOutputStreambuf - ZipOutputStreambuf is a zip output streambuf filter.

Synopsis

       #include <zipoutputstreambuf.h>

       Inherits zipios::DeflateOutputStreambuf.

   PublicTypes
       enum CompressionLevels { NO_COMPRESSION = Z_NO_COMPRESSION, BEST_SPEED = Z_BEST_SPEED, BEST_COMPRESSION =
           Z_BEST_COMPRESSION, DEFAULT_COMPRESSION = Z_DEFAULT_COMPRESSION }

   PublicMemberFunctionsZipOutputStreambuf (streambuf *outbuf, bool del_outbuf=false)
           ZipOutputStreambuf constructor.
       void closeEntry ()
           Closes the current entry, and positions the stream read pointer at the beginning of the next entry
           (if there is one).
       void close ()
           Calls finish.
       void finish ()
           Closes the current entry (if one is open), then writes the Zip Central Directory Structure closing
           the ZipOutputStream.
       void putNextEntry (const ZipCDirEntry &entry)
           Begins writing the next entry.
       void setComment (const string &comment)
           Sets the global comment for the Zip archive.
       void setLevel (int level)
           Sets the compression level to be used for subsequent entries.
       void setMethod (StorageMethod method)
           Sets the compression method to be used.
       virtual ~ZipOutputStreambuf ()
           Destructor.

   ProtectedMemberFunctions
       virtual int overflow (int c=EOF)
       virtual int sync ()
       void setEntryClosedState ()
       void updateEntryHeaderInfo ()

   StaticProtectedMemberFunctions
       static void writeCentralDirectory (const vector< ZipCDirEntry > &entries, EndOfCentralDirectory eocd,
           ostream &os)

   AdditionalInheritedMembers

See Also