Skip to content

Defined in header <fkYAML/node.hpp>

fkyaml::basic_node::alias_of

static basic_node alias_of(const basic_node& anchor);

Creates an alias YAML node from an anchor node.

Parameters

anchor [in]
A basic_node object with an anchor name.
This node must have some anchor name.

Return Value

An alias YAML node which is created from the given anchor node.
If the given anchor node does not have any non-empty anchor name, an fkyaml::exception will be thrown.

Note

If this API throws an exception, the internally stored YAML node value in the given anchor node stays intact.

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

int main() {
    // create a YAML node.
    fkyaml::node anchor_node = "test";

    // add an anchor name to the node.
    anchor_node.add_anchor_name("anchor");

    // create an alias YAML node.
    fkyaml::node alias_node = fkyaml::node::alias_of(anchor_node);

    // print the value in the alias node.
    std::cout << alias_node.get_value_ref<fkyaml::node::string_type&>() << std::endl;

    return 0;
}

output: 

test

See Also