Description

stream_generator приведет к использованию стандартного стримингового оператора для своего типа A, например:

std::ostream& operator<< (std::ostream&, A const&);

Header

// forwards to <boost/spirit/home/karma/stream.hpp>
#include <boost/spirit/include/karma_stream.hpp>

Также см. Include Structure.

Namespace

Synopsis

template <typename Char>
struct stream_generator;

Template parameters

Model of

Expression Semantics

Семантика выражения определяется только там, где она отличается от или не определяется в PrimitiveGenerator.

Все генераторы, перечисленные в таблице выше, являются предопределенными специализациями stream_generator<Char> основного типа генератора потока, описанного ниже. Можно непосредственно использовать этот тип для создания потоковых генераторов с использованием произвольного основного типа.

stream_generator<
    Char
>()

stream_generator<
    Char
>()(s)

stream_generator<
    Char
>()(s)

Additional Requirements

Все перечисленные выше потоковые генераторы требуют типа значения для генерации выходной информации (будь то непосредственное значение или связанный с ним атрибут) для реализации потокового оператора, соответствующего обычным I/O-конвенциям потоков (где ttribute_type является типом значения для генерации выходной информации):

template <typename Ostream>
Ostream& operator<< (Ostream& os, attribute_type const& attr)
{
    // type specific output generation
    return os;
}

Этот оператор будет называться потоковыми генераторами, чтобы собрать выход для атрибута типа attribute_type. Все данные, передаваемые в данный Ostream, в конечном итоге будут генерироваться соответствующим экземпляром генератора потока.

	Note
	Если stream генератор используется внутри формат> (или оператор<;()) потокового манипулятора потока Ostream перешел к оператору<() будет зарегистрирован (имбуировано) тот же стандартный локальный экземпляр, что и поток информатор><>>>>> Это гарантирует, что все грани, зарегистрированные (изображенные) с исходным I/O потоковым объектом, используются во время производства.

Attributes

	Important
	Тип атрибута hold_any, подверженный воздействию некоторых потоковых генераторов семантически и синтаксически эквивалентен типу, реализованному Boost.Any. Он был добавлен к Spirit, поскольку он имеет лучшую производительность и меньший след по сравнению с Boost.Any.

	Note
	В дополнение к их обычному атрибуту типа Attrib все перечисленные генераторы принимают экземпляр boost:: Опционально<Attrib> Если boost::факультативно< инициализируется (оставляет значение) генераторы ведут себя так, как будто их атрибут был экземпляром Attrib и испускают значение, хранящееся в boost::факультативно<>. Иначе генераторы потерпят неудачу.

Complexity

Example

	Note
	Испытательный узел для примера (примеров) ниже представлен в разделе Basics examples.

Некоторые из них включают:

#include <boost/spirit/include/karma.hpp>
#include <boost/spirit/include/support_utree.hpp>
#include <boost/spirit/include/phoenix_core.hpp>
#include <boost/spirit/include/phoenix_operator.hpp>
#include <boost/fusion/include/std_pair.hpp>
#include <iostream>
#include <string>

Некоторые используют заявления:

using boost::spirit::karma::stream;

И классовое определение, используемое в примерах:

// a simple complex number representation z = a + bi
struct complex
{
    complex (double a, double b)
      : a(a), b(b)
    {}
    double a;
    double b;
};

// define streaming operator for the type complex
std::ostream&
operator<< (std::ostream& os, complex const& z)
{
    os << "{" << z.a << "," << z.b << "}";
    return os;
}

Основное использование генераторов stream:

test_generator_attr("abc", stream, "abc");
test_generator("abc", stream("abc"));
test_generator_attr("{1.2,2.4}", stream, complex(1.2, 2.4));
test_generator("{1.2,2.4}", stream(complex(1.2, 2.4)));