io.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013-2026 Regents of the University of California.
 *
 * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
 *
 * ndn-cxx library is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later version.
 *
 * ndn-cxx library 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 Lesser General Public License for more details.
 *
 * You should have received copies of the GNU General Public License and GNU Lesser
 * General Public License along with ndn-cxx, e.g., in COPYING.md file.  If not, see
 * <http://www.gnu.org/licenses/>.
 *
 * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
 */
 
#ifndef NDN_CXX_UTIL_IO_HPP
#define NDN_CXX_UTIL_IO_HPP
 
#include "ndn-cxx/encoding/block.hpp"
#include "ndn-cxx/util/concepts.hpp"
 
#include <fstream>
 
namespace ndn::io {
 
class Error : public std::runtime_error
{
public:
  using std::runtime_error::runtime_error;
};
 
enum IoEncoding {
  NO_ENCODING,
 
  BASE64,
 
  HEX,
};
 
namespace detail {
 
template<typename T>
constexpr void
checkNestedError(typename T::Error*)
{
  static_assert(std::is_convertible_v<typename T::Error*, tlv::Error*>,
                "T::Error, if defined, must be a subclass of ndn::tlv::Error");
}
 
template<typename T>
constexpr void
checkNestedError(...)
{
  // T::Error is not defined
}
 
} // namespace detail
 
shared_ptr<Buffer>
loadBuffer(std::istream& is, IoEncoding encoding = BASE64);
 
template<typename T>
T
loadTlv(std::istream& is, IoEncoding encoding = BASE64)
{
  BOOST_CONCEPT_ASSERT((WireDecodable<T>));
 
  auto buf = loadBuffer(is, encoding);
  try {
    return T(Block(buf));
  }
  catch (const std::exception& e) {
    NDN_THROW_NESTED(Error("Decode error during load: "s + e.what()));
  }
}
 
template<typename T>
[[deprecated("use loadTlv")]]
shared_ptr<T>
load(std::istream& is, IoEncoding encoding = BASE64)
{
  BOOST_CONCEPT_ASSERT((WireDecodable<T>));
  detail::checkNestedError<T>(nullptr);
 
  Block block;
  try {
    block = Block(loadBuffer(is, encoding));
  }
  catch (const std::invalid_argument&) {
    return nullptr;
  }
  catch (const std::runtime_error&) {
    return nullptr;
  }
 
  try {
    return make_shared<T>(block);
  }
  catch (const tlv::Error&) {
    return nullptr;
  }
}
 
template<typename T>
[[deprecated("use loadTlv")]]
shared_ptr<T>
load(const std::string& filename, IoEncoding encoding = BASE64)
{
  std::ifstream is(filename);
  return load<T>(is, encoding);
}
 
void
saveBuffer(span<const uint8_t> buf, std::ostream& os, IoEncoding encoding = BASE64);
 
template<typename T>
void
saveTlv(const T& obj, std::ostream& os, IoEncoding encoding = BASE64)
{
  BOOST_CONCEPT_ASSERT((WireEncodable<T>));
 
  Block block;
  try {
    block = obj.wireEncode();
  }
  catch (const std::exception& e) {
    NDN_THROW_NESTED(Error("Encode error during save: "s + e.what()));
  }
 
  saveBuffer(block, os, encoding);
}
 
template<typename T>
[[deprecated("use saveTlv")]]
void
save(const T& obj, std::ostream& os, IoEncoding encoding = BASE64)
{
  BOOST_CONCEPT_ASSERT((WireEncodable<T>));
  detail::checkNestedError<T>(nullptr);
 
  Block block;
  try {
    block = obj.wireEncode();
  }
  catch (const tlv::Error& e) {
    NDN_THROW_NESTED(Error("Encode error during save: "s + e.what()));
  }
 
  saveBuffer(block, os, encoding);
}
 
template<typename T>
[[deprecated("use saveTlv")]]
void
save(const T& obj, const std::string& filename, IoEncoding encoding = BASE64)
{
  std::ofstream os(filename);
  save(obj, os, encoding);
}
 
} // namespace ndn::io
 
#endif // NDN_CXX_UTIL_IO_HPP