boost::asio::mutable_buffer

Holds a buffer that can be modified.

Synopsis

Declared in <boost/asio/buffer.hpp>

class mutable_buffer;

Member Functions

Name

Description

mutable_buffer [constructor]

Constructors

Get a pointer to the beginning of the memory range.

Move the start of the buffer by the specified number of bytes.

Get the size of the memory range.

Non-Member Functions

Name

Description

Create a new modifiable buffer that represents the given POD array.

Create a new modifiable buffer that represents the given string.

Create a new modifiable buffer from an existing buffer.

Create a new modifiable buffer from a span.

Create a new modifiable buffer from a contiguous container.

Create a new modifiable buffer that represents the given POD array.

Create a new modifiable buffer from a contiguous container.

Create a new modifiable buffer that represents the given POD array.

Create a new modifiable buffer that represents the given POD array.

Create a new modifiable buffer that represents the given POD array.

Create a new modifiable buffer that represents the given POD vector.

Create a new modifiable buffer that represents the given POD vector.

Create a new modifiable buffer from a span.

Create a new modifiable buffer from an existing buffer.

Create a new modifiable buffer that represents the given POD array.

Create a new modifiable buffer that represents the given string.

Create a new modifiable buffer that represents the given memory range.

buffer_sequence_begin

Get an iterator to the first element in a buffer sequence.

buffer_sequence_begin

Get an iterator to the first element in a buffer sequence.

buffer_sequence_end

Get an iterator to one past the end element in a buffer sequence.

buffer_sequence_end

Get an iterator to one past the end element in a buffer sequence.

Create a new modifiable buffer that is offset from the start of another.

Create a new modifiable buffer that is offset from the start of another.

Description

The mutable_buffer class provides a safe representation of a buffer that can be modified. It does not own the underlying data, and so is cheap to copy or assign.

Accessing Buffer Contents

The contents of a buffer may be accessed using the data() and size() member functions:

boost::asio::mutable_buffer b1 = ...;
std::size_t s1 = b1.size();
unsigned char* p1 = static_cast<unsigned char*>(b1.data());

The data() member function permits violations of type safety, so uses of it in application code should be carefully considered.

Created with MrDocs

Edit this Page