blob: 0e1c2df82f27856dbbe7319b17cfc4ad91958311 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
//
// VMime library (http://www.vmime.org)
// Copyright (C) 2002 Vincent Richard <vincent@vmime.org>
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License as
// published by the Free Software Foundation; either version 3 of
// the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
// Linking this library statically or dynamically with other modules is making
// a combined work based on this library. Thus, the terms and conditions of
// the GNU General Public License cover the whole combination.
//
#ifndef VMIME_UTILITY_INPUTSTREAM_HPP_INCLUDED
#define VMIME_UTILITY_INPUTSTREAM_HPP_INCLUDED
#include "vmime/utility/stream.hpp"
namespace vmime {
namespace utility {
/** Simple input stream.
*/
class VMIME_EXPORT inputStream : public stream {
public:
/** Test for end of stream (no more data to read).
*
* @return true if we have reached the end of stream, false otherwise
*/
virtual bool eof() const = 0;
/** Set the read pointer to the beginning of the stream.
*
* @warning WARNING: this may not work for all stream types.
*/
virtual void reset() = 0;
/** Read data from the stream.
*
* @param data will receive the data read
* @param count maximum number of bytes to read
* @return number of bytes read
*/
virtual size_t read(byte_t* const data, const size_t count) = 0;
/** Skip a number of bytes.
*
* @param count maximum number of bytes to ignore
* @return number of bytes skipped
*/
virtual size_t skip(const size_t count) = 0;
};
} // utility
} // vmime
#endif // VMIME_UTILITY_INPUTSTREAM_HPP_INCLUDED
|