Node

YAML node.

This is a pseudo-dynamic type that can store any YAML value, including a sequence or mapping of nodes. You can get data from a Node directly or iterate over it if it's a collection.

struct Node {

alias Pair = .Pair;

alias Value = Algebraic!(YAMLNull, YAMLMerge, bool, long, real, ubyte[], SysTime, string, Node.Pair[], Node[], YAMLObject);

template allowed(T);

ScalarStyle scalarStyle;

CollectionStyle collectionStyle;

eponymoustemplate scalarCtorNothrow(T);

this(T value, string tag);

this(T value, string tag);

this(T[] array, string tag);

this(V[K] array, string tag);

this(K[] keys, V[] values, string tag);

bool isValid [@property getter];

bool isScalar [@property getter];

bool isSequence [@property getter];

bool isMapping [@property getter];

bool isUserType [@property getter];

bool isNull [@property getter];

string tag [@property getter];

bool opEquals(T rhs);

alias as = get;

T get [@property getter];

T get [@property getter];

size_t length [@property getter];

Node opIndex(T index);

bool contains(T rhs);

bool containsKey(T rhs);

void opAssign(Node rhs);

void opAssign(Node rhs);

void opIndexAssign(V value, K index);

int opApply(int delegate(ref T) dg);

int opApply(int delegate(ref K, ref V) dg);

void add(T value);

void add(K key, V value);

Node* opBinaryRight(K key);

void remove(T rhs);

void removeAt(T index);

int opCmp(Node node);

hash_t toHash();

static Node rawNode(Value value, Mark startMark, Tag tag, ScalarStyle scalarStyle, CollectionStyle collectionStyle);

static Value userValue(T value);

static Value value(T value);

bool equals(T rhs);

int cmp(Node rhs);

uint debugString [@property setter];

TypeInfo type [@property getter];

bool isType [@property getter];

alias isBool = isType!bool;

alias isBinary = isType!(ubyte[]);

alias isInt = isType!long;

alias isFloat = isType!real;

alias isString = isType!string;

alias isTime = isType!SysTime;

bool hasEqualType(Node node);

string nodeTypeString [@property getter];

bool convertsTo [@property getter];

}

Constructors

this this(T value, string tag): Construct a Node from a value.
this this(T[] array, string tag): Construct a node from an _array.
this this(V[K] array, string tag): Construct a node from an associative _array.
this this(K[] keys, V[] values, string tag): Construct a node from arrays of _keys and _values.

Members

Aliases

Pair alias Pair = .Pair: Undocumented in source.
Value alias Value = Algebraic!(YAMLNull, YAMLMerge, bool, long, real, ubyte[], SysTime, string, Node.Pair[], Node[], YAMLObject): Undocumented in source.
as alias as = get: Shortcut for get().
isBinary alias isBinary = isType!(ubyte[]): Undocumented in source.
isBool alias isBool = isType!bool: Undocumented in source.
isFloat alias isFloat = isType!real: Undocumented in source.
isInt alias isInt = isType!long: Undocumented in source.
isString alias isString = isType!string: Undocumented in source.
isTime alias isTime = isType!SysTime: Undocumented in source.

Enums

scalarCtorNothrow eponymoustemplate scalarCtorNothrow(T): Undocumented in source.

Functions

add void add(T value): Add an element to a sequence.
add void add(K key, V value): Add a key-value pair to a mapping.
cmp int cmp(Node rhs): Undocumented in source. Be warned that the author may not have intended to support it.
contains bool contains(T rhs): Determine if a collection contains specified value.
containsKey bool containsKey(T rhs): Determine if a mapping contains specified key.
equals bool equals(T rhs): Undocumented in source. Be warned that the author may not have intended to support it.
hasEqualType bool hasEqualType(Node node): Undocumented in source. Be warned that the author may not have intended to support it.
opApply int opApply(int delegate(ref T) dg): Foreach over a sequence, getting each element as T.
opApply int opApply(int delegate(ref K, ref V) dg): Foreach over a mapping, getting each key/value as K/V.
opAssign void opAssign(Node rhs): Assignment (shallow copy) by value.
opAssign void opAssign(Node rhs): Assignment (shallow copy) by reference.
opBinaryRight Node* opBinaryRight(K key): Determine whether a key is in a mapping, and access its value.
opCmp int opCmp(Node node): Compare with another _node.
opEquals bool opEquals(T rhs): Equality test.
opIndex Node opIndex(T index): Get the element at specified index.
opIndexAssign void opIndexAssign(V value, K index): Set element at specified index in a collection.
remove void remove(T rhs): Remove first (if any) occurence of a value in a collection.
removeAt void removeAt(T index): Remove element at the specified index of a collection.
toHash hash_t toHash(): Undocumented in source. Be warned that the author may not have intended to support it.

Properties

convertsTo bool convertsTo [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
debugString uint debugString [@property setter]: Undocumented in source. Be warned that the author may not have intended to support it.
get T get [@property getter]: Get the value of the node as specified type.
isMapping bool isMapping [@property getter]: Is this node a mapping?
isNull bool isNull [@property getter]: Is this node null?
isScalar bool isScalar [@property getter]: Is this node a scalar value?
isSequence bool isSequence [@property getter]: Is this node a sequence?
isType bool isType [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
isUserType bool isUserType [@property getter]: Is this node a user defined type?
isValid bool isValid [@property getter]: Is this node valid (initialized)?
length size_t length [@property getter]: If this is a collection, return its length.
nodeTypeString string nodeTypeString [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
tag string tag [@property getter]: Return tag of the node.
type TypeInfo type [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.

Static functions

rawNode Node rawNode(Value value, Mark startMark, Tag tag, ScalarStyle scalarStyle, CollectionStyle collectionStyle): Undocumented in source. Be warned that the author may not have intended to support it.
userValue Value userValue(T value): Undocumented in source. Be warned that the author may not have intended to support it.
value Value value(T value): Undocumented in source. Be warned that the author may not have intended to support it.

Templates

allowed template allowed(T): Undocumented in source.

Variables

collectionStyle CollectionStyle collectionStyle;: Undocumented in source.
scalarStyle ScalarStyle scalarStyle;: Undocumented in source.
tag_ Tag tag_;: Undocumented in source.

Meta

Source

See Implementation

dyaml node classes

enums

NodeID

functions

merge

structs