buffer.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013-2024 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.
 *
 * @author Alexander Afanasyev <http://lasr.cs.ucla.edu/afanasyev/index.html>
 */
 
#ifndef NDN_CXX_ENCODING_BUFFER_HPP
#define NDN_CXX_ENCODING_BUFFER_HPP
 
#include <cstdint>
#include <initializer_list>
#include <iosfwd>
#include <memory>
#include <vector>
 
namespace ndn {
 
class Buffer : public std::vector<uint8_t>
{
public:
  Buffer() = default;
 
  Buffer(const Buffer&);
 
  Buffer&
  operator=(const Buffer&);
 
  Buffer(Buffer&&) noexcept;
 
  Buffer&
  operator=(Buffer&&) noexcept;
 
  explicit
  Buffer(size_t size)
    : std::vector<uint8_t>(size, 0)
  {
  }
 
  Buffer(const void* buf, size_t length)
    : std::vector<uint8_t>(reinterpret_cast<const uint8_t*>(buf),
                           reinterpret_cast<const uint8_t*>(buf) + length)
  {
  }
 
  template<class InputIt>
  Buffer(InputIt first, InputIt last)
    : std::vector<uint8_t>(first, last)
  {
  }
 
  Buffer(std::initializer_list<uint8_t> il)
    : std::vector<uint8_t>(il)
  {
  }
 
  template<class T>
  T*
  get() noexcept
  {
    return reinterpret_cast<T*>(data());
  }
 
  template<class T>
  const T*
  get() const noexcept
  {
    return reinterpret_cast<const T*>(data());
  }
};
 
inline
Buffer::Buffer(const Buffer&) = default;
 
inline Buffer&
Buffer::operator=(const Buffer&) = default;
 
inline
Buffer::Buffer(Buffer&&) noexcept = default;
 
inline Buffer&
Buffer::operator=(Buffer&&) noexcept = default;
 
std::ostream&
boost_test_print_type(std::ostream&, const Buffer&);
using BufferPtr = std::shared_ptr<Buffer>;
using ConstBufferPtr = std::shared_ptr<const Buffer>;
 
} // namespace ndn
 
#endif // NDN_CXX_ENCODING_BUFFER_HPP