Struct MessagesChunkIter

Struct Documentation

struct MessagesChunkIter

Convenient iterator class to go over all of the messages in a chunk.

Public Types

using iterator_category = std::forward_iterator_tag

Iterator category tag for forward iterator.

using value_type = MessageRef

Type of value returned by dereferencing the iterator.

using difference_type = std::ptrdiff_t

Type representing the difference between two iterators.

using pointer = std::unique_ptr<MessageRef>

Type of pointer returned by operator->.

using reference = MessageRef&

Type of reference returned by operator*.

Public Functions

MessagesChunkIter(const MessagesChunkIter &other)

Initialize the MessagesChunkIter from another MessageChunkIter object.

Parameters:

other[in] The other MessagesChunkIter to initalize from.

MessagesChunkIter &operator=(const MessagesChunkIter &other) = default

Default assignment operation.

Parameters:

other[in] The other MessageChunkIter to assign to.

MessageRef operator*() const

Gets the current ChunkRef via value.

Returns:

The current ChunkRef value.

std::unique_ptr<const MessageRef> operator->() const

Gets the current ChunkRef via smart pointer.

Returns:

The current ChunkRef smart pointer.

MessagesChunkIter &operator++()

Advance to the next message in the chunk.

Returns:

*this

MessagesChunkIter operator++(int)

Advance to the next message in the chunk.

Returns:

*this

MessagesChunkIter &operator--()

Regress to the previous message in the chunk.

Returns:

*this

MessagesChunkIter operator--(int)

Regress to the previous message in the chunk.

Returns:

*this

bool operator==(const MessagesChunkIter &other) const

Check if two MessagesChunkIter are equal.

Parameters:

other[in] The other MessagesChunkIter to check against.

Returns:

If the two MessagesChunkIter are equal.

bool operator!=(const MessagesChunkIter &other) const

Check if two MessagesChunkIter are not equal.

Parameters:

other[in] The other MessagesChunkIter to check against.

Returns:

If the two MessagesChunkIter are not equal.

std::string to_string() const

Debug string representation.

Returns:

The string representation of a MessagesChunkIter.

bool done() const

Check if the MessagesChunkIter is at the end of the iteration.

Returns:

True if the MessagesChunkIter is at the end of the iteration,

void next()

Advance to the next message in the chunk.