zipios  2.3.2
Zipios -- a small C++ library that provides easy access to .zip files.
streamentry.hpp
Go to the documentation of this file.
1 #pragma once
2 #ifndef ZIPIOS_STREAMENTRY_HPP
3 #define ZIPIOS_STREAMENTRY_HPP
4 
5 /*
6  Zipios -- a small C++ library that provides easy access to .zip files.
7 
8  Copyright (C) 2000-2007 Thomas Sondergaard
9  Copyright (c) 2015-2022 Made to Order Software Corp. All Rights Reserved
10 
11  This library is free software; you can redistribute it and/or
12  modify it under the terms of the GNU Lesser General Public
13  License as published by the Free Software Foundation; either
14  version 2.1 of the License, or (at your option) any later version.
15 
16  This library is distributed in the hope that it will be useful,
17  but WITHOUT ANY WARRANTY; without even the implied warranty of
18  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19  Lesser General Public License for more details.
20 
21  You should have received a copy of the GNU Lesser General Public
22  License along with this library; if not, write to the Free Software
23  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 */
25 
35 #include "zipios/fileentry.hpp"
36 
37 
38 namespace zipios
39 {
40 
41 
42 class StreamEntry : public FileEntry
43 {
44 public:
45  typedef std::shared_ptr<StreamEntry> pointer_t;
46 
48  std::istream & is
49  , FilePath const & filename
50  , std::string const & comment = std::string());
51  virtual FileEntry::pointer_t clone() const override;
52  virtual ~StreamEntry() override;
53 
54  virtual bool isEqual(FileEntry const & file_entry) const override;
55  uint32_t computeCRC32() const;
56  std::istream & getStream() const;
57 
58 private:
59  std::istream & f_istream;
60 };
61 
62 
63 } // zipios namespace
64 
65 // Local Variables:
66 // mode: cpp
67 // indent-tabs-mode: nil
68 // c-basic-offset: 4
69 // tab-width: 4
70 // End:
71 
72 // vim: ts=4 sw=4 et
73 #endif
std::istream & getStream() const
Retrieve a reference to the istream object.
The zipios namespace includes the Zipios library definitions.
Definition: backbuffer.cpp:35
uint32_t computeCRC32() const
Compute the CRC32 of this file.
A file entry reading from a stream.
Definition: streamentry.hpp:42
virtual FileEntry::pointer_t clone() const override
Create a copy of the StreamEntry.
Definition: streamentry.cpp:96
virtual ~StreamEntry() override
Clean up a StreamEntry object.
A FileEntry represents an entry in a FileCollection.
Definition: fileentry.hpp:75
std::shared_ptr< StreamEntry > pointer_t
Definition: streamentry.hpp:45
Handle a file path and name and its statistics.
Definition: filepath.hpp:46
std::istream & f_istream
Definition: streamentry.hpp:59
StreamEntry(std::istream &is, FilePath const &filename, std::string const &comment=std::string())
Initialize a StreamEntry object.
Definition: streamentry.cpp:67
virtual bool isEqual(FileEntry const &file_entry) const override
Compare two file entries for equality.
Define the zipios::FileEntry class.
std::shared_ptr< FileEntry > pointer_t
Definition: fileentry.hpp:78