Fredg1: create dump()

2020-09-20T23:19:58Z

create dump()

New page

{{
#vardefine:name|dump}}{{
#vardefine:return_type|void}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
return_type={{#var:return_type}}|
parameter1={{Param|any|composite}}|
}}|

function2={{Function|
name={{#var:name}}|
return_type={{#var:return_type}}|
parameter1={{Param|any|composite}}|
parameter2={{Param|string|color}}|
p1desc={{Pspan|composite}} is the variable to dump. Can be any data type (besides ''void''), but the intended use is with [[Data_Types#aggregate|an aggregate]] or [[Data_Types#record|a record]].|
p2desc={{Pspan|color}} is an html color name or code. See [[print]] for more information.|
}}|
function_description="Dumps" (i.e. "unfolds", showing every key/field of the variable, and their value) {{pspan|composite}} to the CLI (in <color>, if specified and valid) and to the session logs.<br>
If {{pspan|composite}} isn't a composite value (record or aggregate), functions similarly to print().|

code1={{CodeSample|
title=Code Sample|
description=This example starts with [https://kolmafia.us/showthread.php?280-Records-in-ASH Veracity's introductory example on records].|
code=
<syntaxhighlight>
/* definition */
record my_type {
int ifield;
string sfield;
record {
int first;
int second;
} rfield;
int [int, int] mfield;
};

my_type rvar;
my_type [int] mrvar;

/* population/assignments */
rvar.ifield = 10;
rvar.sfield = "secret";
rvar.rfield.first = 1000;
rvar.rfield.second = 2000;
rvar.mfield[ 2, 3 ] = 12;

mrvar[ 1 ] = rvar;
</syntaxhighlight>|
}}|

code2={{CodeSample|
description=Then, instead of using ''foreach'' loops, simply does:|
code=
<syntaxhighlight>
dump(mrvar);
</syntaxhighlight>|
moreinfo=which will print in the CLI:
<pre>
aggregate my_type [int]
1 => record my_type
  ifield => 10
  sfield => secret
  rfield => record (anonymous record 7dbf2293)
    first => 1000
    second => 2000
  mfield => aggregate int [int, int]
    2 => aggregate int [int]
      3 => 12
</pre>
}}|

cli_equiv=This is the equivalent of returning/ending with a variable with the CLI command "ash", minus the color option.|
see_also={{SeeAlso|print|logprint}}|
special=[https://kolmafia.us/showthread.php?25398-print()&p=158966&viewfull=1#post158966 Take note that the behaviour of this function with non-composite values is NOT the exact same as print().]
}}

[[Category:Miscellaneous Functions]]

Dump - Revision history

Fredg1: create dump()