estimator.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013-2022 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_ENCODING_ESTIMATOR_HPP
#define NDN_CXX_ENCODING_ESTIMATOR_HPP
 
#include "ndn-cxx/encoding/block.hpp"
 
namespace ndn {
namespace encoding {
 
class Estimator : noncopyable
{
public: // common interface between Encoder and Estimator
  constexpr size_t
  prependBytes(span<const uint8_t> bytes) const noexcept
  {
    return bytes.size();
  }
 
  constexpr size_t
  appendBytes(span<const uint8_t> bytes) const noexcept
  {
    return bytes.size();
  }
 
  [[deprecated("use prependBytes()")]]
  constexpr size_t
  prependByte(uint8_t) const noexcept
  {
    return 1;
  }
 
  [[deprecated("use appendBytes()")]]
  constexpr size_t
  appendByte(uint8_t) const noexcept
  {
    return 1;
  }
 
  [[deprecated("use prependBytes()")]]
  constexpr size_t
  prependByteArray(const uint8_t*, size_t length) const noexcept
  {
    return length;
  }
 
  [[deprecated("use appendBytes()")]]
  constexpr size_t
  appendByteArray(const uint8_t*, size_t length) const noexcept
  {
    return length;
  }
 
  template<class Iterator>
  constexpr size_t
  prependRange(Iterator first, Iterator last) const noexcept
  {
    return std::distance(first, last);
  }
 
  template<class Iterator>
  constexpr size_t
  appendRange(Iterator first, Iterator last) const noexcept
  {
    return std::distance(first, last);
  }
 
  constexpr size_t
  prependVarNumber(uint64_t n) const noexcept
  {
    return tlv::sizeOfVarNumber(n);
  }
 
  constexpr size_t
  appendVarNumber(uint64_t n) const noexcept
  {
    return tlv::sizeOfVarNumber(n);
  }
 
  constexpr size_t
  prependNonNegativeInteger(uint64_t n) const noexcept
  {
    return tlv::sizeOfNonNegativeInteger(n);
  }
 
  constexpr size_t
  appendNonNegativeInteger(uint64_t n) const noexcept
  {
    return tlv::sizeOfNonNegativeInteger(n);
  }
 
  [[deprecated("use encoding::prependBinaryBlock()")]]
  constexpr size_t
  prependByteArrayBlock(uint32_t type, const uint8_t* array, size_t arraySize) const noexcept
  {
    return tlv::sizeOfVarNumber(type) + tlv::sizeOfVarNumber(arraySize) + arraySize;
  }
 
  [[deprecated]]
  constexpr size_t
  appendByteArrayBlock(uint32_t type, const uint8_t* array, size_t arraySize) const noexcept
  {
    return tlv::sizeOfVarNumber(type) + tlv::sizeOfVarNumber(arraySize) + arraySize;
  }
 
  [[deprecated("use encoding::prependBlock()")]]
  size_t
  prependBlock(const Block& block) const;
 
  [[deprecated]]
  size_t
  appendBlock(const Block& block) const;
};
 
} // namespace encoding
} // namespace ndn
 
#endif // NDN_CXX_ENCODING_ESTIMATOR_HPP