mirror of https://github.com/vitalif/grive2
56 lines
1.7 KiB
C++
56 lines
1.7 KiB
C++
/*
|
|
webwrite: an GPL program to sync a local directory with Google Drive
|
|
Copyright (C) 2012 Wan Wai Ho
|
|
|
|
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 version 2
|
|
of the License.
|
|
|
|
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.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <cstddef>
|
|
|
|
namespace gr {
|
|
|
|
/** \brief Encapsulation of data streams. Useful for unit tests.
|
|
This class provides two functions: Read() and Write().
|
|
*/
|
|
class DataStream
|
|
{
|
|
protected :
|
|
virtual ~DataStream() {}
|
|
|
|
public :
|
|
/** Reading from the stream. The caller indicates that it wants
|
|
to read `size` bytes and must provide enough space pointed
|
|
by `data`.
|
|
\param data Buffer to hold the data read from the stream
|
|
Must have at least `size` bytes.
|
|
\param size Number of bytes the caller wants to read.
|
|
\throw wb::Exception In case of any error.
|
|
\return The number of byte actually read from the stream.
|
|
0 indicates the end of stream, i.e. you will
|
|
still get 0 if you call again.
|
|
*/
|
|
virtual std::size_t Read( char *data, std::size_t size ) = 0 ;
|
|
virtual std::size_t Write( const char *data, std::size_t size ) = 0 ;
|
|
} ;
|
|
|
|
/// Stream for /dev/null, i.e. read and writing nothing
|
|
DataStream* DevNull() ;
|
|
|
|
|
|
|
|
} // end of namespace
|