2011-10-14 08:34:53 +00:00
< !DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
< html lang = 'en' >
< head >
< meta http-equiv = "content-type" content = "text/html; charset=utf-8" >
2014-08-01 01:00:40 +00:00
< title > dyaml.representer - D:YAML 0.5 API documentation< / title >
2011-10-14 08:34:53 +00:00
< link rel = "stylesheet" type = "text/css" href = "css/style.css" >
< / head >
< body > < div id = "top" >
< div id = "header" >
2014-08-01 01:00:40 +00:00
< img id = "logo" alt = "D:YAML logo" src = "images/logo.png" > < a id = "main-heading" href = "index.html" > D:YAML 0.5 API documentation< / a >
2011-10-14 08:34:53 +00:00
< / div >
< / div >
< div id = "navigation" >
< div class = "navblock" >
< div id = "toctop" >
< ul > < li > < a href = "../index.html" > Documentation home< / a > < / li >
< / ul >
< / div >
< / div >
< div class = "navblock" >
< ul > < li > < a href = "index.html" > Main page< / a > < / li >
< li > < a href = "dyaml.constructor.html" > dyaml.constructor< / a > < / li >
< li > < a href = "dyaml.dumper.html" > dyaml.dumper< / a > < / li >
< li > < a href = "dyaml.exception.html" > dyaml.exception< / a > < / li >
2014-05-19 17:54:48 +00:00
< li > < a href = "dyaml.hacks.html" > dyaml.hacks< / a > < / li >
2011-10-14 08:34:53 +00:00
< li > < a href = "dyaml.linebreak.html" > dyaml.linebreak< / a > < / li >
< li > < a href = "dyaml.loader.html" > dyaml.loader< / a > < / li >
< li > < a href = "dyaml.node.html" > dyaml.node< / a > < / li >
< li > < a href = "dyaml.representer.html" > dyaml.representer< / a > < / li >
< li > < a href = "dyaml.resolver.html" > dyaml.resolver< / a > < / li >
2011-10-29 18:43:30 +00:00
< li > < a href = "dyaml.style.html" > dyaml.style< / a > < / li >
2011-10-14 08:34:53 +00:00
< / ul >
< / div >
< / div >
< div id = "content" >
< h1 > dyaml.representer< / h1 >
<!-- Generated by Ddoc from dyaml/representer.d -->
2011-10-15 14:31:23 +00:00
< p > YAML node representer. Prepares YAML nodes for output. A tutorial can be
found < a href = "../tutorials/custom_types.html" > here< / a > .
2011-10-14 08:34:53 +00:00
< / p >
< p > Code based on < a href = "http://www.pyyaml.org" > PyYAML< / a > .< / p >
2014-08-01 01:00:40 +00:00
< dl > < dt class = "d_decl" > < a name = "RepresenterException" > < / a > class < a name = "RepresenterException" > < / a > < span class = "ddoc_psymbol" > RepresenterException< / span > : < u > dyaml.exception.YAMLException< / u > ;
2011-10-14 08:34:53 +00:00
< / dt >
< dd > < p > Exception thrown on Representer errors.< / p >
< / dd >
2013-12-17 14:19:01 +00:00
< dt class = "d_decl" > < a name = "Representer" > < / a > class < a name = "Representer" > < / a > < span class = "ddoc_psymbol" > Representer< / span > ;
2011-10-14 08:34:53 +00:00
< / dt >
2012-01-23 14:57:26 +00:00
< dd > < p > Represents YAML nodes as scalar, sequence and mapping nodes ready for output.
2011-10-27 21:13:14 +00:00
< / p >
< p > This class is used to add support for dumping of custom data types.
< br >
It can also override default node formatting styles for output.< / p >
2011-10-14 08:34:53 +00:00
2014-08-01 01:00:40 +00:00
< dl > < dt class = "d_decl" > < a name = "Representer.this" > < / a > pure @safe this(const Flag!"< b > useDefaultRepresenters< / b > " < b > useDefaultRepresenters< / b > = Yes.< b > useDefaultRepresenters< / b > );
2011-10-14 08:34:53 +00:00
< / dt >
< dd > < p > Construct a Representer.
< / p >
2013-12-17 14:19:01 +00:00
< b > Parameters:< / b > < div class = "pbr" > < table class = parms > < tr > < td valign = top > Flag!"< b > useDefaultRepresenters< / b > " < b > useDefaultRepresenters< / b > < / td >
2011-10-14 08:34:53 +00:00
< td valign = top > Use default representer functions
for default YAML types? This can be
disabled to use custom representer
functions for default types.< / td > < / tr >
< / table > < / div >
2011-10-27 21:13:14 +00:00
< / dd >
2013-12-17 14:19:01 +00:00
< dt class = "d_decl" > < a name = "Representer.defaultScalarStyle" > < / a > pure nothrow @property @safe void < a name = "defaultScalarStyle" > < / a > < span class = "ddoc_psymbol" > defaultScalarStyle< / span > (ScalarStyle < b > style< / b > );
2011-10-27 21:13:14 +00:00
< / dt >
2012-01-23 14:57:26 +00:00
< dd > < p > Set default style for scalars. If < b > style< / b > is < span class = "d_inlinecode" > ScalarStyle.Invalid< / span > , the style is chosen automatically.< / p >
2011-10-27 21:13:14 +00:00
< / dd >
2013-12-17 14:19:01 +00:00
< dt class = "d_decl" > < a name = "Representer.defaultCollectionStyle" > < / a > pure nothrow @property @safe void < a name = "defaultCollectionStyle" > < / a > < span class = "ddoc_psymbol" > defaultCollectionStyle< / span > (CollectionStyle < b > style< / b > );
2011-10-27 21:13:14 +00:00
< / dt >
2014-08-01 01:00:40 +00:00
< dd > < p > Set default style for collections. If < b > style< / b > is < span class = "d_inlinecode" > CollectionStyle.Invalid< / span > , the style is chosen automatically.< / p >
2011-10-27 21:13:14 +00:00
2011-10-14 08:34:53 +00:00
< / dd >
2013-12-17 14:19:01 +00:00
< dt class = "d_decl" > < a name = "Representer.addRepresenter" > < / a > pure @trusted void < a name = "addRepresenter" > < / a > < span class = "ddoc_psymbol" > addRepresenter< / span > (T)(Node function(ref Node, Representer) < b > representer< / b > );
2011-10-14 08:34:53 +00:00
< / dt >
< dd > < p > Add a function to represent nodes with a specific data type.
< / p >
2012-01-23 14:57:26 +00:00
< p > The representer function takes references to a < span class = "d_inlinecode" > Node< / span > storing the data
type and to the < span class = "d_inlinecode" > Representer< / span > . It returns the represented node and may
throw a < span class = "d_inlinecode" > RepresenterException< / span > . See the example for more information.
< br >
2011-10-14 08:34:53 +00:00
< br >
Only one function may be specified for one data type. Default data
2011-10-18 14:12:22 +00:00
types already have representer functions unless disabled in the
2012-01-23 14:57:26 +00:00
< span class = "d_inlinecode" > Representer< / span > constructor.
< br >
< br >
Structs and classes must implement the < span class = "d_inlinecode" > opCmp()< / span > operator for D:YAML
support. The signature of the operator that must be implemented
is < span class = "d_inlinecode" > const int opCmp(ref const MyStruct s)< / span > for structs where
< i > MyStruct< / i > is the struct type, and < span class = "d_inlinecode" > int opCmp(Object o)< / span > for
classes. Note that the class < span class = "d_inlinecode" > opCmp()< / span > should not alter the compared
values - it is not const for compatibility reasons.
2011-10-14 08:34:53 +00:00
< / p >
2013-12-17 14:19:01 +00:00
< b > Parameters:< / b > < div class = "pbr" > < table class = parms > < tr > < td valign = top > Node function(ref Node, Representer) representer< / td >
2011-10-14 08:34:53 +00:00
< td valign = top > Representer function to add.< / td > < / tr >
< / table > < / div >
2014-08-01 01:00:40 +00:00
< b > Examples:< / b > < div class = "pbr" > Representing a simple struct:
2013-12-17 14:19:01 +00:00
< pre class = "d_code" > < span class = "d_keyword" > import< / span > std.string;
< span class = "d_keyword" > import< / span > dyaml.all;
< span class = "d_keyword" > struct< / span > MyStruct
{
< span class = "d_keyword" > int< / span > x, y, z;
< span class = "d_comment" > //Any D:YAML type must have a custom opCmp operator.
< / span > < span class = "d_comment" > //This is used for ordering in mappings.
< / span > < span class = "d_keyword" > const< / span > < span class = "d_keyword" > int< / span > opCmp(< span class = "d_keyword" > ref< / span > < span class = "d_keyword" > const< / span > MyStruct s)
{
< span class = "d_keyword" > if< / span > (x != s.x){< span class = "d_keyword" > return< / span > x - s.x;}
< span class = "d_keyword" > if< / span > (y != s.y){< span class = "d_keyword" > return< / span > y - s.y;}
< span class = "d_keyword" > if< / span > (z != s.z){< span class = "d_keyword" > return< / span > z - s.z;}
< span class = "d_keyword" > return< / span > 0;
}
}
Node representMyStruct(< span class = "d_keyword" > ref< / span > Node node, Representer representer)
{
< span class = "d_comment" > //The node is guaranteed to be MyStruct as we add representer for MyStruct.
< / span > < span class = "d_keyword" > auto< / span > value = node.as!MyStruct;
< span class = "d_comment" > //Using custom scalar format, x:y:z.
< / span > < span class = "d_keyword" > auto< / span > scalar = format(< span class = "d_string" > "%s:%s:%s"< / span > , value.x, value.y, value.z);
< span class = "d_comment" > //Representing as a scalar, with custom tag to specify this data type.
< / span > < span class = "d_keyword" > return< / span > representer.representScalar(< span class = "d_string" > "!mystruct.tag"< / span > , scalar);
}
< span class = "d_keyword" > void< / span > main()
{
< span class = "d_keyword" > auto< / span > dumper = Dumper(< span class = "d_string" > "file.yaml"< / span > );
< span class = "d_keyword" > auto< / span > representer = < span class = "d_keyword" > new< / span > Representer;
representer.< span class = "d_psymbol" > addRepresenter< / span > !MyStruct(& representMyStruct);
dumper.representer = representer;
dumper.dump(Node(MyStruct(1,2,3)));
}
2011-10-14 08:34:53 +00:00
< / pre >
2013-12-17 14:19:01 +00:00
< br >
2011-10-14 08:34:53 +00:00
Representing a class:
2013-12-17 14:19:01 +00:00
< pre class = "d_code" > < span class = "d_keyword" > import< / span > std.string;
< span class = "d_keyword" > import< / span > dyaml.all;
< span class = "d_keyword" > class< / span > MyClass
{
< span class = "d_keyword" > int< / span > x, y, z;
< span class = "d_keyword" > this< / span > (< span class = "d_keyword" > int< / span > x, < span class = "d_keyword" > int< / span > y, < span class = "d_keyword" > int< / span > z)
{
< span class = "d_keyword" > this< / span > .x = x;
< span class = "d_keyword" > this< / span > .y = y;
< span class = "d_keyword" > this< / span > .z = z;
}
< span class = "d_comment" > //Any D:YAML type must have a custom opCmp operator.
< / span > < span class = "d_comment" > //This is used for ordering in mappings.
< / span > < span class = "d_keyword" > override< / span > < span class = "d_keyword" > int< / span > opCmp(Object o)
{
MyClass s = < span class = "d_keyword" > cast< / span > (MyClass)o;
< span class = "d_keyword" > if< / span > (s < span class = "d_keyword" > is< / span > < span class = "d_keyword" > null< / span > ){< span class = "d_keyword" > return< / span > -1;}
< span class = "d_keyword" > if< / span > (x != s.x){< span class = "d_keyword" > return< / span > x - s.x;}
< span class = "d_keyword" > if< / span > (y != s.y){< span class = "d_keyword" > return< / span > y - s.y;}
< span class = "d_keyword" > if< / span > (z != s.z){< span class = "d_keyword" > return< / span > z - s.z;}
< span class = "d_keyword" > return< / span > 0;
}
< span class = "d_comment" > ///Useful for Node.as!string .
< / span > < span class = "d_keyword" > override< / span > string toString()
{
< span class = "d_keyword" > return< / span > format(< span class = "d_string" > "MyClass(%s, %s, %s)"< / span > , x, y, z);
}
}
< span class = "d_comment" > //Same as representMyStruct.
< / span > Node representMyClass(< span class = "d_keyword" > ref< / span > Node node, Representer representer)
{
< span class = "d_comment" > //The node is guaranteed to be MyClass as we add representer for MyClass.
< / span > < span class = "d_keyword" > auto< / span > value = node.as!MyClass;
< span class = "d_comment" > //Using custom scalar format, x:y:z.
< / span > < span class = "d_keyword" > auto< / span > scalar = format(< span class = "d_string" > "%s:%s:%s"< / span > , value.x, value.y, value.z);
< span class = "d_comment" > //Representing as a scalar, with custom tag to specify this data type.
< / span > < span class = "d_keyword" > return< / span > representer.representScalar(< span class = "d_string" > "!myclass.tag"< / span > , scalar);
}
< span class = "d_keyword" > void< / span > main()
{
< span class = "d_keyword" > auto< / span > dumper = Dumper(< span class = "d_string" > "file.yaml"< / span > );
< span class = "d_keyword" > auto< / span > representer = < span class = "d_keyword" > new< / span > Representer;
representer.< span class = "d_psymbol" > addRepresenter< / span > !MyClass(& representMyClass);
dumper.representer = representer;
dumper.dump(Node(< span class = "d_keyword" > new< / span > MyClass(1,2,3)));
}
2011-10-14 08:34:53 +00:00
< / pre >
< / div >
< / dd >
2013-12-17 14:19:01 +00:00
< dt class = "d_decl" > < a name = "Representer.representScalar" > < / a > @safe Node < a name = "representScalar" > < / a > < span class = "ddoc_psymbol" > representScalar< / span > (string < b > tag< / b > , string < b > scalar< / b > , ScalarStyle < b > style< / b > = ScalarStyle.Invalid);
2011-10-14 08:34:53 +00:00
< / dt >
< dd > < p > Represent a scalar with specified tag.
< / p >
< p > This is used by representer functions that produce scalars.
< / p >
< b > Parameters:< / b > < div class = "pbr" > < table class = parms > < tr > < td valign = top > string < b > tag< / b > < / td >
< td valign = top > Tag of the scalar.< / td > < / tr >
< tr > < td valign = top > string < b > scalar< / b > < / td >
< td valign = top > Scalar value.< / td > < / tr >
2011-10-27 21:13:14 +00:00
< tr > < td valign = top > ScalarStyle < b > style< / b > < / td >
2011-10-29 18:43:30 +00:00
< td valign = top > Style of the scalar. If invalid, default style will be used.
If the node was loaded before, previous style will always be used.< / td > < / tr >
2011-10-14 08:34:53 +00:00
< / table > < / div >
< b > Returns:< / b > < div class = "pbr" > The represented node.
< / div >
< p > < b > Example:< / b > < br >
2013-12-17 14:19:01 +00:00
< pre class = "d_code" > < span class = "d_keyword" > struct< / span > MyStruct
{
< span class = "d_keyword" > int< / span > x, y, z;
< span class = "d_comment" > //Any D:YAML type must have a custom opCmp operator.
< / span > < span class = "d_comment" > //This is used for ordering in mappings.
< / span > < span class = "d_keyword" > const< / span > < span class = "d_keyword" > int< / span > opCmp(< span class = "d_keyword" > ref< / span > < span class = "d_keyword" > const< / span > MyStruct s)
{
< span class = "d_keyword" > if< / span > (x != s.x){< span class = "d_keyword" > return< / span > x - s.x;}
< span class = "d_keyword" > if< / span > (y != s.y){< span class = "d_keyword" > return< / span > y - s.y;}
< span class = "d_keyword" > if< / span > (z != s.z){< span class = "d_keyword" > return< / span > z - s.z;}
< span class = "d_keyword" > return< / span > 0;
}
}
Node representMyStruct(< span class = "d_keyword" > ref< / span > Node node, Representer representer)
{
< span class = "d_keyword" > auto< / span > value = node.as!MyStruct;
< span class = "d_keyword" > auto< / span > < span class = "d_param" > scalar< / span > = format(< span class = "d_string" > "%s:%s:%s"< / span > , value.x, value.y, value.z);
< span class = "d_keyword" > return< / span > representer.< span class = "d_psymbol" > representScalar< / span > (< span class = "d_string" > "!mystruct.tag"< / span > , < span class = "d_param" > scalar< / span > );
}
2011-10-14 08:34:53 +00:00
< / pre >
< / p >
< / dd >
2013-12-17 14:19:01 +00:00
< dt class = "d_decl" > < a name = "Representer.representSequence" > < / a > @trusted Node < a name = "representSequence" > < / a > < span class = "ddoc_psymbol" > representSequence< / span > (string < b > tag< / b > , Node[] < b > sequence< / b > , CollectionStyle < b > style< / b > = CollectionStyle.Invalid);
2011-10-14 08:34:53 +00:00
< / dt >
< dd > < p > Represent a sequence with specified tag, representing children first.
< / p >
< p > This is used by representer functions that produce sequences.
< / p >
< b > Parameters:< / b > < div class = "pbr" > < table class = parms > < tr > < td valign = top > string < b > tag< / b > < / td >
2012-01-23 14:57:26 +00:00
< td valign = top > Tag of the sequence.< / td > < / tr >
2011-10-14 08:34:53 +00:00
< tr > < td valign = top > Node[] < b > sequence< / b > < / td >
< td valign = top > Sequence of nodes.< / td > < / tr >
2011-10-27 21:13:14 +00:00
< tr > < td valign = top > CollectionStyle < b > style< / b > < / td >
2011-10-29 18:43:30 +00:00
< td valign = top > Style of the sequence. If invalid, default style will be used.
If the node was loaded before, previous style will always be used.< / td > < / tr >
2011-10-14 08:34:53 +00:00
< / table > < / div >
< b > Returns:< / b > < div class = "pbr" > The represented node.
< / div >
2012-01-23 14:57:26 +00:00
< b > Throws:< / b > < div class = "pbr" > < span class = "d_inlinecode" > RepresenterException< / span > if a child could not be represented.
2011-10-14 08:34:53 +00:00
< / div >
< p > < b > Example:< / b > < br >
2013-12-17 14:19:01 +00:00
< pre class = "d_code" > < span class = "d_keyword" > struct< / span > MyStruct
{
< span class = "d_keyword" > int< / span > x, y, z;
< span class = "d_comment" > //Any D:YAML type must have a custom opCmp operator.
< / span > < span class = "d_comment" > //This is used for ordering in mappings.
< / span > < span class = "d_keyword" > const< / span > < span class = "d_keyword" > int< / span > opCmp(< span class = "d_keyword" > ref< / span > < span class = "d_keyword" > const< / span > MyStruct s)
{
< span class = "d_keyword" > if< / span > (x != s.x){< span class = "d_keyword" > return< / span > x - s.x;}
< span class = "d_keyword" > if< / span > (y != s.y){< span class = "d_keyword" > return< / span > y - s.y;}
< span class = "d_keyword" > if< / span > (z != s.z){< span class = "d_keyword" > return< / span > z - s.z;}
< span class = "d_keyword" > return< / span > 0;
}
}
Node representMyStruct(< span class = "d_keyword" > ref< / span > Node node, Representer representer)
{
< span class = "d_keyword" > auto< / span > value = node.as!MyStruct;
< span class = "d_keyword" > auto< / span > nodes = [Node(value.x), Node(value.y), Node(value.z)];
< span class = "d_comment" > //use flow style
< / span > < span class = "d_keyword" > return< / span > representer.< span class = "d_psymbol" > representSequence< / span > (< span class = "d_string" > "!mystruct.tag"< / span > , nodes,
CollectionStyle.Flow);
}
2011-10-14 08:34:53 +00:00
< / pre >
< / p >
< / dd >
2013-12-17 14:19:01 +00:00
< dt class = "d_decl" > < a name = "Representer.representMapping" > < / a > @trusted Node < a name = "representMapping" > < / a > < span class = "ddoc_psymbol" > representMapping< / span > (string < b > tag< / b > , Node.Pair[] < b > pairs< / b > , CollectionStyle < b > style< / b > = CollectionStyle.Invalid);
2011-10-14 08:34:53 +00:00
< / dt >
< dd > < p > Represent a mapping with specified tag, representing children first.
< / p >
< p > This is used by representer functions that produce mappings.
< / p >
< b > Parameters:< / b > < div class = "pbr" > < table class = parms > < tr > < td valign = top > string < b > tag< / b > < / td >
< td valign = top > Tag of the mapping.< / td > < / tr >
2013-12-17 14:19:01 +00:00
< tr > < td valign = top > Node.Pair[] < b > pairs< / b > < / td >
2011-10-14 08:34:53 +00:00
< td valign = top > Key-value pairs of the mapping.< / td > < / tr >
2011-10-27 21:13:14 +00:00
< tr > < td valign = top > CollectionStyle < b > style< / b > < / td >
2011-10-29 18:43:30 +00:00
< td valign = top > Style of the mapping. If invalid, default style will be used.
If the node was loaded before, previous style will always be used.< / td > < / tr >
2011-10-14 08:34:53 +00:00
< / table > < / div >
< b > Returns:< / b > < div class = "pbr" > The represented node.
< / div >
2012-01-23 14:57:26 +00:00
< b > Throws:< / b > < div class = "pbr" > < span class = "d_inlinecode" > RepresenterException< / span > if a child could not be represented.
2011-10-14 08:34:53 +00:00
< / div >
< p > < b > Example:< / b > < br >
2013-12-17 14:19:01 +00:00
< pre class = "d_code" > < span class = "d_keyword" > struct< / span > MyStruct
{
< span class = "d_keyword" > int< / span > x, y, z;
< span class = "d_comment" > //Any D:YAML type must have a custom opCmp operator.
< / span > < span class = "d_comment" > //This is used for ordering in mappings.
< / span > < span class = "d_keyword" > const< / span > < span class = "d_keyword" > int< / span > opCmp(< span class = "d_keyword" > ref< / span > < span class = "d_keyword" > const< / span > MyStruct s)
{
< span class = "d_keyword" > if< / span > (x != s.x){< span class = "d_keyword" > return< / span > x - s.x;}
< span class = "d_keyword" > if< / span > (y != s.y){< span class = "d_keyword" > return< / span > y - s.y;}
< span class = "d_keyword" > if< / span > (z != s.z){< span class = "d_keyword" > return< / span > z - s.z;}
< span class = "d_keyword" > return< / span > 0;
}
}
Node representMyStruct(< span class = "d_keyword" > ref< / span > Node node, Representer representer)
{
< span class = "d_keyword" > auto< / span > value = node.as!MyStruct;
< span class = "d_keyword" > auto< / span > < span class = "d_param" > pairs< / span > = [Node.Pair(< span class = "d_string" > "x"< / span > , value.x),
Node.Pair(< span class = "d_string" > "y"< / span > , value.y),
Node.Pair(< span class = "d_string" > "z"< / span > , value.z)];
< span class = "d_keyword" > return< / span > representer.< span class = "d_psymbol" > representMapping< / span > (< span class = "d_string" > "!mystruct.tag"< / span > , < span class = "d_param" > pairs< / span > );
}
2011-10-14 08:34:53 +00:00
< / pre >
< / p >
< / dd >
< / dl >
< / dd >
2013-12-17 14:19:01 +00:00
< dt class = "d_decl" > < a name = "representNull" > < / a > @safe Node < a name = "representNull" > < / a > < span class = "ddoc_psymbol" > representNull< / span > (ref Node < b > node< / b > , Representer < b > representer< / b > );
2011-10-14 08:34:53 +00:00
< / dt >
< dd > < p > Represent a null node as a null YAML value.< / p >
< / dd >
2013-12-17 14:19:01 +00:00
< dt class = "d_decl" > < a name = "representString" > < / a > @safe Node < a name = "representString" > < / a > < span class = "ddoc_psymbol" > representString< / span > (ref Node < b > node< / b > , Representer < b > representer< / b > );
2011-10-14 08:34:53 +00:00
< / dt >
< dd > < p > Represent a string node as a string scalar.< / p >
< / dd >
2013-12-17 14:19:01 +00:00
< dt class = "d_decl" > < a name = "representBytes" > < / a > @system Node < a name = "representBytes" > < / a > < span class = "ddoc_psymbol" > representBytes< / span > (ref Node < b > node< / b > , Representer < b > representer< / b > );
2011-10-14 08:34:53 +00:00
< / dt >
< dd > < p > Represent a bytes node as a binary scalar.< / p >
< / dd >
2013-12-17 14:19:01 +00:00
< dt class = "d_decl" > < a name = "representBool" > < / a > @safe Node < a name = "representBool" > < / a > < span class = "ddoc_psymbol" > representBool< / span > (ref Node < b > node< / b > , Representer < b > representer< / b > );
2011-10-14 08:34:53 +00:00
< / dt >
< dd > < p > Represent a bool node as a bool scalar.< / p >
< / dd >
2013-12-17 14:19:01 +00:00
< dt class = "d_decl" > < a name = "representLong" > < / a > @system Node < a name = "representLong" > < / a > < span class = "ddoc_psymbol" > representLong< / span > (ref Node < b > node< / b > , Representer < b > representer< / b > );
2011-10-14 08:34:53 +00:00
< / dt >
< dd > < p > Represent a long node as an integer scalar.< / p >
< / dd >
2013-12-17 14:19:01 +00:00
< dt class = "d_decl" > < a name = "representReal" > < / a > @system Node < a name = "representReal" > < / a > < span class = "ddoc_psymbol" > representReal< / span > (ref Node < b > node< / b > , Representer < b > representer< / b > );
2011-10-14 08:34:53 +00:00
< / dt >
< dd > < p > Represent a real node as a floating point scalar.< / p >
< / dd >
2013-12-17 14:19:01 +00:00
< dt class = "d_decl" > < a name = "representSysTime" > < / a > @system Node < a name = "representSysTime" > < / a > < span class = "ddoc_psymbol" > representSysTime< / span > (ref Node < b > node< / b > , Representer < b > representer< / b > );
2011-10-14 08:34:53 +00:00
< / dt >
< dd > < p > Represent a SysTime node as a timestamp.< / p >
< / dd >
2013-12-17 14:19:01 +00:00
< dt class = "d_decl" > < a name = "representNodes" > < / a > @safe Node < a name = "representNodes" > < / a > < span class = "ddoc_psymbol" > representNodes< / span > (ref Node < b > node< / b > , Representer < b > representer< / b > );
2011-10-14 08:34:53 +00:00
< / dt >
< dd > < p > Represent a sequence node as sequence/set.< / p >
< / dd >
2013-12-17 14:19:01 +00:00
< dt class = "d_decl" > < a name = "representPairs" > < / a > @system Node < a name = "representPairs" > < / a > < span class = "ddoc_psymbol" > representPairs< / span > (ref Node < b > node< / b > , Representer < b > representer< / b > );
2011-10-14 08:34:53 +00:00
< / dt >
< dd > < p > Represent a mapping node as map/ordered map/pairs.< / p >
< / dd >
< / dl >
< / div >
< div id = "copyright" >
2014-08-01 01:00:40 +00:00
Copyright © Ferdinand Majerech 2011-2014. Based on < a href = "http://www.pyyaml.org" > PyYAML< / a > by Kirill Simonov. |
2012-01-23 14:57:26 +00:00
Page generated by AutoDDoc and < a href = "http://www.digitalmars.com/d/2.0/ddoc.html" > Ddoc< / a > .
2011-10-14 08:34:53 +00:00
< / div >
< / body >
< / html >
