Skip to content

Defined in header <fkYAML/node.hpp>

fkyaml::operator<<

inline std::ostream& operator<<(std::ostream& os, const basic_node& n);

Serializes a node value into an output stream.
This operator is a wrapper of the basic_node::serialize() function to simplify the implementation in the client code.
For details, please visit the documentation of the serialize() function.

Template Parameters

SequenceType
Type for sequence node value containers.
MappingType
Type for mapping node value containers.
BooleanType
Type for boolean node values.
IntegerType
Type for integer node values.
FloatNumberType
Type for float number node values.
StringType
Type for string node values.
ConverterType
Type for converters between nodes and values of native data types.

Parameters

os [in]
An output stream object.
n [in]
A basic_node object.

Return Value

Reference to the output stream object os.

Examples

Example
#include <iostream>
#include <fkYAML/node.hpp>

int main() {
    // create a basic_node object.
    fkyaml::node n = {{"foo", true}, {"bar", {1, 2, 3}}, {"baz", {{"qux", 3.14}, {"corge", nullptr}}}};

    // serialize the basic_node object with insertion operator.
    // this is equivalent with:
    //   std::cout << fkyaml::node::serialize(n) << std::endl;
    std::cout << n << std::endl;

    return 0;
}

output:

bar:
  - 1
  - 2
  - 3
baz:
  corge: null
  qux: 3.14
foo: true

See Also