1// Copyright (c) 2015-present The Bitcoin Core developers
2// Distributed under the MIT software license, see the accompanying
3// file COPYING or http://www.opensource.org/licenses/mit-license.php.
4
5#ifndef BITCOIN_UTIL_READWRITEFILE_H
6#define BITCOIN_UTIL_READWRITEFILE_H
7
8#include <util/fs.h>
9
10#include <cstddef>
11#include <limits>
12#include <string>
13#include <utility>
14
15/** Read full contents of a file and return them in a std::string.
16 * Returns a pair <status, string>.
17 * If an error occurred, status will be false, otherwise status will be true and the data will be returned in string.
18 *
19 * @param maxsize Puts a maximum size limit on the file that is read. If the file is larger than this, truncated data
20 *         (with len > maxsize) will be returned.
21 */
22std::pair<bool,std::string> ReadBinaryFile(const fs::path &filename, size_t maxsize=std::numeric_limits<size_t>::max());
23
24/** Write contents of std::string to a file.
25 * @return true on success.
26 */
27bool WriteBinaryFile(const fs::path &filename, const std::string &data);
28
29#endif // BITCOIN_UTIL_READWRITEFILE_H
30