ndn::Buffer Class Reference

General-purpose automatically managed/resized buffer. More...

#include <buffer.hpp>

Inheritance diagram for ndn::Buffer:

Collaboration diagram for ndn::Buffer:

Public Member Functions
	Buffer ()=default
	Creates an empty Buffer. More...
	Buffer (const Buffer &)
	Copy constructor. More...
Buffer &	operator= (const Buffer &)
	Copy assignment operator. More...
	Buffer (Buffer &&) noexcept
	Move constructor. More...
Buffer &	operator= (Buffer &&) noexcept
	Move assignment operator. More...
	Buffer (size_t size)
	Creates a Buffer with pre-allocated size. More...
	Buffer (const void *buf, size_t length)
	Creates a Buffer by copying contents from a raw buffer. More...
template<class InputIt >
	Buffer (InputIt first, InputIt last)
	Creates a Buffer by copying the elements of the range [first, last) More...
	Buffer (std::initializer_list< uint8_t > il)
	Creates a Buffer with the contents of an initializer list. More...
template<class T >
T *	get () noexcept
template<class T >
const T *	get () const noexcept

Detailed Description

General-purpose automatically managed/resized buffer.

In most respect, the Buffer class is equivalent to a std::vector<uint8_t>, and it in fact uses the latter as a base class. In addition to that, it provides the get<T>() helper method that automatically casts the returned pointer to the requested type.

Definition at line 41 of file buffer.hpp.

Constructor & Destructor Documentation

Buffer() [1/7]

ndn::Buffer::Buffer ( )

default

Creates an empty Buffer.

Referenced by get().

Buffer() [2/7]

ndn::Buffer::Buffer ( const Buffer &  )

inlinedefault

Copy constructor.

Buffer() [3/7]

ndn::Buffer::Buffer ( Buffer &&  )

inlinedefaultnoexcept

Move constructor.

Buffer() [4/7]

ndn::Buffer::Buffer ( size_t  size )

inlineexplicit

Creates a Buffer with pre-allocated size.

Parameters

size	size of the Buffer to be allocated

Definition at line 70 of file buffer.hpp.

Buffer() [5/7]

ndn::Buffer::Buffer ( const void *  buf, size_t  length  )

inline

Creates a Buffer by copying contents from a raw buffer.

Parameters

buf	const pointer to buffer to copy
length	length of the buffer to copy

Definition at line 79 of file buffer.hpp.

Buffer() [6/7]

template<class InputIt >

ndn::Buffer::Buffer ( InputIt  first, InputIt  last  )

inline

Creates a Buffer by copying the elements of the range [first, last)

Parameters

first	an input iterator to the first element to copy
last	an input iterator to the element immediately following the last element to copy

Definition at line 90 of file buffer.hpp.

Buffer() [7/7]

ndn::Buffer::Buffer ( std::initializer_list< uint8_t >  il )

inline

Creates a Buffer with the contents of an initializer list.

Definition at line 97 of file buffer.hpp.

Member Function Documentation

operator=() [1/2]

Buffer & ndn::Buffer::operator= ( const Buffer &  )

inlinedefault

Copy assignment operator.

Referenced by get().

operator=() [2/2]

Buffer & ndn::Buffer::operator= ( Buffer &&  )

inlinedefaultnoexcept

Move assignment operator.

get() [1/2]

template<class T >

T* ndn::Buffer::get ( )

inlinenoexcept

Returns

pointer to the first byte of the buffer, cast to the requested type T

Definition at line 106 of file buffer.hpp.

get() [2/2]

template<class T >

const T* ndn::Buffer::get ( ) const

inlinenoexcept

Returns

const pointer to the first byte of the buffer, cast to the requested type T

Definition at line 115 of file buffer.hpp.

References ndn::boost_test_print_type(), Buffer(), and operator=().

---

The documentation for this class was generated from the following file:

• ndnSIM/ndn-cxx/ndn-cxx/encoding/buffer.hpp