Clementine
Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
asio::buffers_iterator< BufferSequence, ByteType > Class Template Reference

A random access iterator over the bytes in a buffer sequence. More...

#include <buffers_iterator.hpp>

Public Types

typedef std::ptrdiff_t difference_type
 The type used for the distance between two iterators.
 
typedef ByteType value_type
 The type of the value pointed to by the iterator.
 
typedef detail::buffers_iterator_types< BufferSequence, ByteType >::byte_type * pointer
 
typedef detail::buffers_iterator_types< BufferSequence, ByteType >::byte_type & reference
 
typedef std::random_access_iterator_tag iterator_category
 The iterator category.
 

Public Member Functions

 buffers_iterator ()
 Default constructor. Creates an iterator in an undefined state.
 
reference operator* () const
 Dereference an iterator.
 
pointer operator-> () const
 Dereference an iterator.
 
reference operator[] (std::ptrdiff_t difference) const
 Access an individual element.
 
buffers_iteratoroperator++ ()
 Increment operator (prefix).
 
buffers_iterator operator++ (int)
 Increment operator (postfix).
 
buffers_iteratoroperator-- ()
 Decrement operator (prefix).
 
buffers_iterator operator-- (int)
 Decrement operator (postfix).
 
buffers_iteratoroperator+= (std::ptrdiff_t difference)
 Addition operator.
 
buffers_iteratoroperator-= (std::ptrdiff_t difference)
 Subtraction operator.
 

Static Public Member Functions

static buffers_iterator begin (const BufferSequence &buffers)
 Construct an iterator representing the beginning of the buffers' data.
 
static buffers_iterator end (const BufferSequence &buffers)
 Construct an iterator representing the end of the buffers' data.
 

Friends

buffers_iterator operator+ (const buffers_iterator &iter, std::ptrdiff_t difference)
 Addition operator.
 
buffers_iterator operator+ (std::ptrdiff_t difference, const buffers_iterator &iter)
 Addition operator.
 
buffers_iterator operator- (const buffers_iterator &iter, std::ptrdiff_t difference)
 Subtraction operator.
 
std::ptrdiff_t operator- (const buffers_iterator &a, const buffers_iterator &b)
 Subtraction operator.
 
bool operator== (const buffers_iterator &a, const buffers_iterator &b)
 Test two iterators for equality.
 
bool operator!= (const buffers_iterator &a, const buffers_iterator &b)
 Test two iterators for inequality.
 
bool operator< (const buffers_iterator &a, const buffers_iterator &b)
 Compare two iterators.
 
bool operator<= (const buffers_iterator &a, const buffers_iterator &b)
 Compare two iterators.
 
bool operator> (const buffers_iterator &a, const buffers_iterator &b)
 Compare two iterators.
 
bool operator>= (const buffers_iterator &a, const buffers_iterator &b)
 Compare two iterators.
 

Detailed Description

template<typename BufferSequence, typename ByteType = char>
class asio::buffers_iterator< BufferSequence, ByteType >

A random access iterator over the bytes in a buffer sequence.


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