# dyaml.hacks - D:YAML 0.5 API documentation

D:YAML 0.5 API documentation

# dyaml.hacks

Functionality that may sometimes be needed but allows unsafe or unstandard behavior, and should only be used in specific cases.

nothrow @safe ScalarStyle scalarStyleHack(ref const(Node) node);

  Get the scalar style a node had in the file it was loaded from.

  This is only useful for nodes loaded from files.
  This is a "hack" because a YAML application is supposed to be unaware of styles used in YAML styles, i.e. treating different styles differently is unstandard. However, determining style may be useful in some cases, e.g. YAML utilities.
  May only be called on scalar nodes (nodes where node.isScalar() == true).

  Example:

      // Node node // loaded from a file
      if(node.isScalar)
      {
          import std.stdio;
          writeln(node.scalarStyleHack());
      }

nothrow @safe CollectionStyle collectionStyleHack(ref const(Node) node);

  Get the collection style a YAML node had in the file it was loaded from.

  May only be called on collection nodes (nodes where node.isScalar() != true).

  See Also:
  scalarStyleHack
nothrow @safe void scalarStyleHack(ref Node node, const ScalarStyle rhs);

  Set the scalar style node should have when written to a file.

  Setting the style might be useful when generating YAML or reformatting existing
  files.
  May only be called on scalar nodes (nodes where node.isScalar() == true).

  Examples:

      writeln("D:YAML scalarStyleHack setter unittest");
      auto node = Node(5);
      node.scalarStyleHack = ScalarStyle.DoubleQuoted;
      assert(node.scalarStyleHack() == ScalarStyle.DoubleQuoted);

nothrow @safe void collectionStyleHack(ref Node node, const CollectionStyle rhs);

  Set the collection style node should have when written to a file.

  Setting the style might be useful when generating YAML or reformatting existing
  files.
  May only be called on collection nodes (nodes where node.isScalar() != true).

  Examples:

      writeln("D:YAML collectionStyleHack setter unittest");
      auto node = Node([1, 2, 3, 4, 5]);
      node.collectionStyleHack = CollectionStyle.Block;
      assert(node.collectionStyleHack() == CollectionStyle.Block);

Copyright © Ferdinand Majerech 2011-2014. Based on PyYAML by Kirill Simonov. | Page generated by AutoDDoc and Ddoc.