Concept Consumer

Boost C++ Libraries

Concept Consumer

Consumer

Description

A Consumer is a type grouping two functions that read a certain number of elements off a range, hence making it a facility to segment a range.

Associated types

input_type
```
Consumer::input_type
```
The type of elements the consumer consumes.

Notation

Consumer: A type playing the role of model of Consumer in the Consumer concept.
In: A type playing the role of model of Bidirectional Iterator with elements convertible to input_type in the Consumer concept.
c: Object of type Consumer
begin, end: Objects of type In

Valid expressions

Name	Expression	Type	Precondition	Semantics
Construction	Consumer()	Consumer		Construct an instance of the type with default parameters.
Left to right	c.ltr(begin, end)	In	`begin != end`	Reads part of the [`begin`, `end`[ range left to right, and returns the new begin iterator.
Right to left	c.rtl(begin, end)	In	`begin != end`	Reads part of the [`begin`, `end`[ range right to left, and returns the new past-the-end iterator.

Models

boost::boundary_consumer<BoundaryChecker>, boost::unicode::combiner