folly::IOBuf::Iterator Class Reference

#include <IOBuf.h>

Inheritance diagram for folly::IOBuf::Iterator:

Public Member Functions
	Iterator (const IOBuf *pos, const IOBuf *end)
	Iterator ()
	Iterator (Iterator const &rhs)
Iterator &	operator= (Iterator const &rhs)
const ByteRange &	dereference () const
bool	equal (const Iterator &other) const
void	increment ()
Public Member Functions inherited from folly::detail::IteratorFacade< IOBuf::Iterator, ByteRange const, std::forward_iterator_tag >
bool	operator== (IOBuf::Iteratorconst &rhs) const
std::enable_if< std::is_convertible< IOBuf::Iterator, D2 >::value, bool >::type	operator== (D2 const &rhs) const
bool	operator!= (IOBuf::Iteratorconst &rhs) const
bool	operator!= (D2 const &rhs) const
ByteRange const &	operator* () const
ByteRange const *	operator-> () const
IOBuf::Iterator &	operator++ ()
IOBuf::Iterator	operator++ (int)
IOBuf::Iterator &	operator-- ()
IOBuf::Iterator	operator-- (int)

Private Member Functions
void	setVal ()
void	adjustForEnd ()

Private Attributes
const IOBuf *	pos_ {nullptr}
const IOBuf *	end_ {nullptr}
ByteRange	val_

Additional Inherited Members
Public Types inherited from folly::detail::IteratorFacade< IOBuf::Iterator, ByteRange const, std::forward_iterator_tag >
using	value_type = ByteRange const
using	reference = value_type &
using	pointer = value_type *
using	difference_type = ssize_t
using	iterator_category = std::forward_iterator_tag

Detailed Description

Definition at line 1619 of file IOBuf.h.

Constructor & Destructor Documentation

folly::IOBuf::Iterator::Iterator ( const IOBuf *  pos, const IOBuf *  end  )

inlineexplicit

Definition at line 1629 of file IOBuf.h.

                                                        : pos_(pos), end_(end) {
    // Sadly, we must return by const reference, not by value.
    if (pos_) {
      setVal();
    }
  }

folly::IOBuf::Iterator::Iterator ( )

inline

Definition at line 1636 of file IOBuf.h.

{}

folly::IOBuf::Iterator::Iterator ( Iterator const &  rhs )

inline

Definition at line 1638 of file IOBuf.h.

: Iterator(rhs.pos_, rhs.end_) {}

Member Function Documentation

void folly::IOBuf::Iterator::adjustForEnd ( )

inlineprivate

Definition at line 1670 of file IOBuf.h.

References end_.

                      {
    if (pos_ == end_) {
      pos_ = end_ = nullptr;
      val_ = ByteRange();
    } else {
      setVal();
    }
  }

const ByteRange& folly::IOBuf::Iterator::dereference ( ) const

inline

Definition at line 1649 of file IOBuf.h.

                                       {
    return val_;
  }

bool folly::IOBuf::Iterator::equal ( const Iterator &  other ) const

inline

Definition at line 1653 of file IOBuf.h.

References end_, end_, and pos_.

                                          {
    // We must compare end_ in addition to pos_, because forward traversal
    // requires that if two iterators are equal (a == b) and dereferenceable,
    // then ++a == ++b.
    return pos_ == other.pos_ && end_ == other.end_;
  }

void folly::IOBuf::Iterator::increment ( )

inline

Definition at line 1660 of file IOBuf.h.

                   {
    pos_ = pos_->next();
    adjustForEnd();
  }

Iterator& folly::IOBuf::Iterator::operator= ( Iterator const &  rhs )

inline

Definition at line 1640 of file IOBuf.h.

References end_, end_, and pos_.

                                           {
    pos_ = rhs.pos_;
    end_ = rhs.end_;
    if (pos_) {
      setVal();
    }
    return *this;
  }

void folly::IOBuf::Iterator::setVal ( )

inlineprivate

Definition at line 1666 of file IOBuf.h.

                {
    val_ = ByteRange(pos_->data(), pos_->tail());
  }

Member Data Documentation

const IOBuf* folly::IOBuf::Iterator::end_ {nullptr}

private

Definition at line 1680 of file IOBuf.h.

Referenced by equal(), and operator=().

const IOBuf* folly::IOBuf::Iterator::pos_ {nullptr}

private

Definition at line 1679 of file IOBuf.h.

Referenced by equal(), and operator=().

ByteRange folly::IOBuf::Iterator::val_

private

Definition at line 1681 of file IOBuf.h.

---

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

• proxygen/folly/folly/io/IOBuf.h