📁 File Manager Pro
v10.0.3 | PHP: 8.1.34
Server: Apache
2026-06-22 12:19:40
📂
/ (Root)
/
opt
/
alt
/
ruby21
/
share
/
doc
/
ruby
/
capi
/
html
/
dc
/
d26
📍 /opt/alt/ruby21/share/doc/ruby/capi/html/dc/d26
🔄 Refresh
✏️
Editing: group__emitter.html
Read Only
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.14"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>Ruby: Emitter Definitions</title> <link href="../../tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="../../jquery.js"></script> <script type="text/javascript" src="../../dynsections.js"></script> <link href="../../doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">Ruby  <span id="projectnumber">2.1.10p492(2016-04-01revision54464)</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.14 --> <script type="text/javascript" src="../../menudata.js"></script> <script type="text/javascript" src="../../menu.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('../../',false,false,'search.php','Search'); }); /* @license-end */</script> <div id="main-nav"></div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#nested-classes">Data Structures</a> | <a href="#typedef-members">Typedefs</a> | <a href="#enum-members">Enumerations</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">Emitter Definitions</div> </div> </div><!--header--> <div class="contents"> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> Data Structures</h2></td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d17/structyaml__emitter__s.html">yaml_emitter_s</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The emitter structure. <a href="../../df/d17/structyaml__emitter__s.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> Typedefs</h2></td></tr> <tr class="memitem:ga1669659aacbe631ad406c78fce1f5379"><td class="memItemLeft" align="right" valign="top">typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d26/group__emitter.html#ga1669659aacbe631ad406c78fce1f5379">yaml_write_handler_t</a>(void *data, unsigned char *buffer, size_t <a class="el" href="../../d8/d36/signal_8c.html#a56fae156d59e6ee797fe8dc8389262c4">size</a>)</td></tr> <tr class="memdesc:ga1669659aacbe631ad406c78fce1f5379"><td class="mdescLeft"> </td><td class="mdescRight">The prototype of a write handler. <a href="#ga1669659aacbe631ad406c78fce1f5379">More...</a><br /></td></tr> <tr class="separator:ga1669659aacbe631ad406c78fce1f5379"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga0889461fa3efe8eee881aef48a4ba6b2"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="../../dc/d26/group__emitter.html#ga387b79da11c3941e43a56947263aa721">yaml_emitter_state_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d26/group__emitter.html#ga0889461fa3efe8eee881aef48a4ba6b2">yaml_emitter_state_t</a></td></tr> <tr class="memdesc:ga0889461fa3efe8eee881aef48a4ba6b2"><td class="mdescLeft"> </td><td class="mdescRight">The emitter states. <a href="#ga0889461fa3efe8eee881aef48a4ba6b2">More...</a><br /></td></tr> <tr class="separator:ga0889461fa3efe8eee881aef48a4ba6b2"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga4ce3e054f0016c49d9e8c36d359e710b"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="../../df/d17/structyaml__emitter__s.html">yaml_emitter_s</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d26/group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a></td></tr> <tr class="memdesc:ga4ce3e054f0016c49d9e8c36d359e710b"><td class="mdescLeft"> </td><td class="mdescRight">The emitter structure. <a href="#ga4ce3e054f0016c49d9e8c36d359e710b">More...</a><br /></td></tr> <tr class="separator:ga4ce3e054f0016c49d9e8c36d359e710b"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> Enumerations</h2></td></tr> <tr class="memitem:ga387b79da11c3941e43a56947263aa721"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d26/group__emitter.html#ga387b79da11c3941e43a56947263aa721">yaml_emitter_state_e</a> { <br />   <a class="el" href="../../dc/d26/group__emitter.html#gga387b79da11c3941e43a56947263aa721aa013a33dab710fe9a30ba014af27b81d">YAML_EMIT_STREAM_START_STATE</a>, <a class="el" href="../../dc/d26/group__emitter.html#gga387b79da11c3941e43a56947263aa721ab1ae25188f02581a137f66c4b6e084ae">YAML_EMIT_FIRST_DOCUMENT_START_STATE</a>, <a class="el" href="../../dc/d26/group__emitter.html#gga387b79da11c3941e43a56947263aa721a678d8c3146f0b2c84e0fc537a9b1109f">YAML_EMIT_DOCUMENT_START_STATE</a>, <a class="el" href="../../dc/d26/group__emitter.html#gga387b79da11c3941e43a56947263aa721a5ce3ed6155496a6fbd7384e310c58bec">YAML_EMIT_DOCUMENT_CONTENT_STATE</a>, <br />   <a class="el" href="../../dc/d26/group__emitter.html#gga387b79da11c3941e43a56947263aa721a100cad4538be033202da4bb85f8443d3">YAML_EMIT_DOCUMENT_END_STATE</a>, <a class="el" href="../../dc/d26/group__emitter.html#gga387b79da11c3941e43a56947263aa721a5a36fc535f3a5720fbb86712959e5654">YAML_EMIT_FLOW_SEQUENCE_FIRST_ITEM_STATE</a>, <a class="el" href="../../dc/d26/group__emitter.html#gga387b79da11c3941e43a56947263aa721aded45f1dee80027d7b9c6ce061c08767">YAML_EMIT_FLOW_SEQUENCE_ITEM_STATE</a>, <a class="el" href="../../dc/d26/group__emitter.html#gga387b79da11c3941e43a56947263aa721ab811f3d642dacc7c413af2c32356f894">YAML_EMIT_FLOW_MAPPING_FIRST_KEY_STATE</a>, <br />   <a class="el" href="../../dc/d26/group__emitter.html#gga387b79da11c3941e43a56947263aa721ababf835ee5cd4c6de2231e2a49e40626">YAML_EMIT_FLOW_MAPPING_KEY_STATE</a>, <a class="el" href="../../dc/d26/group__emitter.html#gga387b79da11c3941e43a56947263aa721aa6f687a6b57e727f0e7b7a2687ad7383">YAML_EMIT_FLOW_MAPPING_SIMPLE_VALUE_STATE</a>, <a class="el" href="../../dc/d26/group__emitter.html#gga387b79da11c3941e43a56947263aa721acb6dbcb535248b8fde779aeedc957b2e">YAML_EMIT_FLOW_MAPPING_VALUE_STATE</a>, <a class="el" href="../../dc/d26/group__emitter.html#gga387b79da11c3941e43a56947263aa721a68af7c090c6d0187788e390341f0cc4d">YAML_EMIT_BLOCK_SEQUENCE_FIRST_ITEM_STATE</a>, <br />   <a class="el" href="../../dc/d26/group__emitter.html#gga387b79da11c3941e43a56947263aa721a8197c180c3cefee7b67304e17b52c5ff">YAML_EMIT_BLOCK_SEQUENCE_ITEM_STATE</a>, <a class="el" href="../../dc/d26/group__emitter.html#gga387b79da11c3941e43a56947263aa721aee36d46c1facecfd73fab73e3343226e">YAML_EMIT_BLOCK_MAPPING_FIRST_KEY_STATE</a>, <a class="el" href="../../dc/d26/group__emitter.html#gga387b79da11c3941e43a56947263aa721a58495cae63b8c3d7c389b1281baeec05">YAML_EMIT_BLOCK_MAPPING_KEY_STATE</a>, <a class="el" href="../../dc/d26/group__emitter.html#gga387b79da11c3941e43a56947263aa721a4aa3c6bf2f2d976c47289c741d7a8704">YAML_EMIT_BLOCK_MAPPING_SIMPLE_VALUE_STATE</a>, <br />   <a class="el" href="../../dc/d26/group__emitter.html#gga387b79da11c3941e43a56947263aa721a7e0f7fac64fc64bb2bc9fe2ec93ca564">YAML_EMIT_BLOCK_MAPPING_VALUE_STATE</a>, <a class="el" href="../../dc/d26/group__emitter.html#gga387b79da11c3941e43a56947263aa721a2a0232912eaf4eeb06594ee6157dfbc0">YAML_EMIT_END_STATE</a> <br /> }</td></tr> <tr class="memdesc:ga387b79da11c3941e43a56947263aa721"><td class="mdescLeft"> </td><td class="mdescRight">The emitter states. <a href="../../dc/d26/group__emitter.html#ga387b79da11c3941e43a56947263aa721">More...</a><br /></td></tr> <tr class="separator:ga387b79da11c3941e43a56947263aa721"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> <tr class="memitem:gac8a99a6fd575f601fd5c9c65a491ea45"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d26/group__emitter.html#gac8a99a6fd575f601fd5c9c65a491ea45">yaml_emitter_initialize</a> (<a class="el" href="../../dc/d26/group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter)</td></tr> <tr class="memdesc:gac8a99a6fd575f601fd5c9c65a491ea45"><td class="mdescLeft"> </td><td class="mdescRight">Initialize an emitter. <a href="#gac8a99a6fd575f601fd5c9c65a491ea45">More...</a><br /></td></tr> <tr class="separator:gac8a99a6fd575f601fd5c9c65a491ea45"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga022057d354df49b2ba201ec2112fdfbf"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d26/group__emitter.html#ga022057d354df49b2ba201ec2112fdfbf">yaml_emitter_delete</a> (<a class="el" href="../../dc/d26/group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter)</td></tr> <tr class="memdesc:ga022057d354df49b2ba201ec2112fdfbf"><td class="mdescLeft"> </td><td class="mdescRight">Destroy an emitter. <a href="#ga022057d354df49b2ba201ec2112fdfbf">More...</a><br /></td></tr> <tr class="separator:ga022057d354df49b2ba201ec2112fdfbf"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gabfaf23e894ddf79c4cdeacd512e61d08"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d26/group__emitter.html#gabfaf23e894ddf79c4cdeacd512e61d08">yaml_emitter_set_output_string</a> (<a class="el" href="../../dc/d26/group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter, unsigned char *<a class="el" href="../../d8/d90/nkf_8c.html#a1b7ce3eca891b24170a721e000ec30c7">output</a>, size_t <a class="el" href="../../d8/d36/signal_8c.html#a56fae156d59e6ee797fe8dc8389262c4">size</a>, size_t *size_written)</td></tr> <tr class="memdesc:gabfaf23e894ddf79c4cdeacd512e61d08"><td class="mdescLeft"> </td><td class="mdescRight">Set a string output. <a href="#gabfaf23e894ddf79c4cdeacd512e61d08">More...</a><br /></td></tr> <tr class="separator:gabfaf23e894ddf79c4cdeacd512e61d08"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gac9aa105b8c90fc0550dbabaa83ab0984"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d26/group__emitter.html#gac9aa105b8c90fc0550dbabaa83ab0984">yaml_emitter_set_output_file</a> (<a class="el" href="../../dc/d26/group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter, <a class="el" href="../../da/d50/vsnprintf_8c.html#a95742987b07c3bc61a7f376b0168410b">FILE</a> *file)</td></tr> <tr class="memdesc:gac9aa105b8c90fc0550dbabaa83ab0984"><td class="mdescLeft"> </td><td class="mdescRight">Set a file output. <a href="#gac9aa105b8c90fc0550dbabaa83ab0984">More...</a><br /></td></tr> <tr class="separator:gac9aa105b8c90fc0550dbabaa83ab0984"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gac02a763e0905749817cceab92b527699"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d26/group__emitter.html#gac02a763e0905749817cceab92b527699">yaml_emitter_set_output</a> (<a class="el" href="../../dc/d26/group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter, <a class="el" href="../../dc/d26/group__emitter.html#ga1669659aacbe631ad406c78fce1f5379">yaml_write_handler_t</a> *handler, void *data)</td></tr> <tr class="memdesc:gac02a763e0905749817cceab92b527699"><td class="mdescLeft"> </td><td class="mdescRight">Set a generic output handler. <a href="#gac02a763e0905749817cceab92b527699">More...</a><br /></td></tr> <tr class="separator:gac02a763e0905749817cceab92b527699"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga6f460de132f4059a6e026a046ffd973a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d26/group__emitter.html#ga6f460de132f4059a6e026a046ffd973a">yaml_emitter_set_encoding</a> (<a class="el" href="../../dc/d26/group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter, <a class="el" href="../../d0/df6/group__basic.html#ga2170996d7e636397b5e6bc0c1b7df7c6">yaml_encoding_t</a> encoding)</td></tr> <tr class="memdesc:ga6f460de132f4059a6e026a046ffd973a"><td class="mdescLeft"> </td><td class="mdescRight">Set the output encoding. <a href="#ga6f460de132f4059a6e026a046ffd973a">More...</a><br /></td></tr> <tr class="separator:ga6f460de132f4059a6e026a046ffd973a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga4126fff1d9f3bc9cbd9b6abe1c7bf300"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d26/group__emitter.html#ga4126fff1d9f3bc9cbd9b6abe1c7bf300">yaml_emitter_set_canonical</a> (<a class="el" href="../../dc/d26/group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter, int <a class="el" href="../../d3/d42/psych__emitter_8c.html#a16d9bc9dfaf8b430daeaffaf019782ff">canonical</a>)</td></tr> <tr class="memdesc:ga4126fff1d9f3bc9cbd9b6abe1c7bf300"><td class="mdescLeft"> </td><td class="mdescRight">Set if the output should be in the "canonical" format as in the YAML specification. <a href="#ga4126fff1d9f3bc9cbd9b6abe1c7bf300">More...</a><br /></td></tr> <tr class="separator:ga4126fff1d9f3bc9cbd9b6abe1c7bf300"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga1755922448720fa0fdb5fd6fb04fe2b1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d26/group__emitter.html#ga1755922448720fa0fdb5fd6fb04fe2b1">yaml_emitter_set_indent</a> (<a class="el" href="../../dc/d26/group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter, int indent)</td></tr> <tr class="memdesc:ga1755922448720fa0fdb5fd6fb04fe2b1"><td class="mdescLeft"> </td><td class="mdescRight">Set the indentation increment. <a href="#ga1755922448720fa0fdb5fd6fb04fe2b1">More...</a><br /></td></tr> <tr class="separator:ga1755922448720fa0fdb5fd6fb04fe2b1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga7d8943ef1c1ba237e77c6d7b6928bee5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d26/group__emitter.html#ga7d8943ef1c1ba237e77c6d7b6928bee5">yaml_emitter_set_width</a> (<a class="el" href="../../dc/d26/group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter, int width)</td></tr> <tr class="memdesc:ga7d8943ef1c1ba237e77c6d7b6928bee5"><td class="mdescLeft"> </td><td class="mdescRight">Set the preferred line width. <a href="#ga7d8943ef1c1ba237e77c6d7b6928bee5">More...</a><br /></td></tr> <tr class="separator:ga7d8943ef1c1ba237e77c6d7b6928bee5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga4e06d64888a25f32138b2e929d0e9543"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d26/group__emitter.html#ga4e06d64888a25f32138b2e929d0e9543">yaml_emitter_set_unicode</a> (<a class="el" href="../../dc/d26/group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter, int unicode)</td></tr> <tr class="memdesc:ga4e06d64888a25f32138b2e929d0e9543"><td class="mdescLeft"> </td><td class="mdescRight">Set if unescaped non-ASCII characters are allowed. <a href="#ga4e06d64888a25f32138b2e929d0e9543">More...</a><br /></td></tr> <tr class="separator:ga4e06d64888a25f32138b2e929d0e9543"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga44ec73ce330ee875c41a985cffa88ce7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d26/group__emitter.html#ga44ec73ce330ee875c41a985cffa88ce7">yaml_emitter_set_break</a> (<a class="el" href="../../dc/d26/group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter, <a class="el" href="../../d0/df6/group__basic.html#ga64d1365e1acd4deeab50d6b48e39cb6d">yaml_break_t</a> line_break)</td></tr> <tr class="memdesc:ga44ec73ce330ee875c41a985cffa88ce7"><td class="mdescLeft"> </td><td class="mdescRight">Set the preferred line break. <a href="#ga44ec73ce330ee875c41a985cffa88ce7">More...</a><br /></td></tr> <tr class="separator:ga44ec73ce330ee875c41a985cffa88ce7"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga674387bc34a739a655f5275176494234"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d26/group__emitter.html#ga674387bc34a739a655f5275176494234">yaml_emitter_emit</a> (<a class="el" href="../../dc/d26/group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter, <a class="el" href="../../d1/ddf/group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *event)</td></tr> <tr class="memdesc:ga674387bc34a739a655f5275176494234"><td class="mdescLeft"> </td><td class="mdescRight">Emit an event. <a href="#ga674387bc34a739a655f5275176494234">More...</a><br /></td></tr> <tr class="separator:ga674387bc34a739a655f5275176494234"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga2196ff07f4c8fe9e4bbe0dbab69c42ef"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d26/group__emitter.html#ga2196ff07f4c8fe9e4bbe0dbab69c42ef">yaml_emitter_open</a> (<a class="el" href="../../dc/d26/group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter)</td></tr> <tr class="memdesc:ga2196ff07f4c8fe9e4bbe0dbab69c42ef"><td class="mdescLeft"> </td><td class="mdescRight">Start a YAML stream. <a href="#ga2196ff07f4c8fe9e4bbe0dbab69c42ef">More...</a><br /></td></tr> <tr class="separator:ga2196ff07f4c8fe9e4bbe0dbab69c42ef"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga0bb06e65d52d245546da60bcb4d86ef8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d26/group__emitter.html#ga0bb06e65d52d245546da60bcb4d86ef8">yaml_emitter_close</a> (<a class="el" href="../../dc/d26/group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter)</td></tr> <tr class="memdesc:ga0bb06e65d52d245546da60bcb4d86ef8"><td class="mdescLeft"> </td><td class="mdescRight">Finish a YAML stream. <a href="#ga0bb06e65d52d245546da60bcb4d86ef8">More...</a><br /></td></tr> <tr class="separator:ga0bb06e65d52d245546da60bcb4d86ef8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gad83d36124da2cd7ccc5c3206b8c00667"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d26/group__emitter.html#gad83d36124da2cd7ccc5c3206b8c00667">yaml_emitter_dump</a> (<a class="el" href="../../dc/d26/group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter, <a class="el" href="../../dd/d58/group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *document)</td></tr> <tr class="memdesc:gad83d36124da2cd7ccc5c3206b8c00667"><td class="mdescLeft"> </td><td class="mdescRight">Emit a YAML document. <a href="#gad83d36124da2cd7ccc5c3206b8c00667">More...</a><br /></td></tr> <tr class="separator:gad83d36124da2cd7ccc5c3206b8c00667"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gab81b1e07666bbefe0815e7aa05d01d19"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d26/group__emitter.html#gab81b1e07666bbefe0815e7aa05d01d19">yaml_emitter_flush</a> (<a class="el" href="../../dc/d26/group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter)</td></tr> <tr class="memdesc:gab81b1e07666bbefe0815e7aa05d01d19"><td class="mdescLeft"> </td><td class="mdescRight">Flush the accumulated characters to the output. <a href="#gab81b1e07666bbefe0815e7aa05d01d19">More...</a><br /></td></tr> <tr class="separator:gab81b1e07666bbefe0815e7aa05d01d19"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <h2 class="groupheader">Typedef Documentation</h2> <a id="ga0889461fa3efe8eee881aef48a4ba6b2"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga0889461fa3efe8eee881aef48a4ba6b2">◆ </a></span>yaml_emitter_state_t</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef enum <a class="el" href="../../dc/d26/group__emitter.html#ga387b79da11c3941e43a56947263aa721">yaml_emitter_state_e</a> <a class="el" href="../../dc/d26/group__emitter.html#ga0889461fa3efe8eee881aef48a4ba6b2">yaml_emitter_state_t</a></td> </tr> </table> </div><div class="memdoc"> <p>The emitter states. </p> </div> </div> <a id="ga4ce3e054f0016c49d9e8c36d359e710b"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga4ce3e054f0016c49d9e8c36d359e710b">◆ </a></span>yaml_emitter_t</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef struct <a class="el" href="../../df/d17/structyaml__emitter__s.html">yaml_emitter_s</a> <a class="el" href="../../dc/d26/group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a></td> </tr> </table> </div><div class="memdoc"> <p>The emitter structure. </p> <p>All members are internal. Manage the structure using the <code>yaml_emitter_</code> family of functions. </p> </div> </div> <a id="ga1669659aacbe631ad406c78fce1f5379"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga1669659aacbe631ad406c78fce1f5379">◆ </a></span>yaml_write_handler_t</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef int yaml_write_handler_t(void *data, unsigned char *buffer, size_t <a class="el" href="../../d8/d36/signal_8c.html#a56fae156d59e6ee797fe8dc8389262c4">size</a>)</td> </tr> </table> </div><div class="memdoc"> <p>The prototype of a write handler. </p> <p>The write handler is called when the emitter needs to flush the accumulated characters to the output. The handler should write <em>size</em> bytes of the <em>buffer</em> to the output.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in,out]</td><td class="paramname">data</td><td>A pointer to an application data specified by <a class="el" href="../../dc/d26/group__emitter.html#gac02a763e0905749817cceab92b527699" title="Set a generic output handler. ">yaml_emitter_set_output()</a>. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>The buffer with bytes to be written. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The size of the buffer.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>On success, the handler should return <code>1</code>. If the handler failed, the returned value should be <code>0</code>. </dd></dl> <p class="definition">Definition at line <a class="el" href="../../dc/dfe/yaml_8h_source.html#l01476">1476</a> of file <a class="el" href="../../dc/dfe/yaml_8h_source.html">yaml.h</a>.</p> </div> </div> <h2 class="groupheader">Enumeration Type Documentation</h2> <a id="ga387b79da11c3941e43a56947263aa721"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga387b79da11c3941e43a56947263aa721">◆ </a></span>yaml_emitter_state_e</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="../../dc/d26/group__emitter.html#ga387b79da11c3941e43a56947263aa721">yaml_emitter_state_e</a></td> </tr> </table> </div><div class="memdoc"> <p>The emitter states. </p> <table class="fieldtable"> <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721aa013a33dab710fe9a30ba014af27b81d"></a>YAML_EMIT_STREAM_START_STATE </td><td class="fielddoc"><p>Expect STREAM-START. </p> </td></tr> <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721ab1ae25188f02581a137f66c4b6e084ae"></a>YAML_EMIT_FIRST_DOCUMENT_START_STATE </td><td class="fielddoc"><p>Expect the first DOCUMENT-START or STREAM-END. </p> </td></tr> <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721a678d8c3146f0b2c84e0fc537a9b1109f"></a>YAML_EMIT_DOCUMENT_START_STATE </td><td class="fielddoc"><p>Expect DOCUMENT-START or STREAM-END. </p> </td></tr> <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721a5ce3ed6155496a6fbd7384e310c58bec"></a>YAML_EMIT_DOCUMENT_CONTENT_STATE </td><td class="fielddoc"><p>Expect the content of a document. </p> </td></tr> <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721a100cad4538be033202da4bb85f8443d3"></a>YAML_EMIT_DOCUMENT_END_STATE </td><td class="fielddoc"><p>Expect DOCUMENT-END. </p> </td></tr> <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721a5a36fc535f3a5720fbb86712959e5654"></a>YAML_EMIT_FLOW_SEQUENCE_FIRST_ITEM_STATE </td><td class="fielddoc"><p>Expect the first item of a flow sequence. </p> </td></tr> <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721aded45f1dee80027d7b9c6ce061c08767"></a>YAML_EMIT_FLOW_SEQUENCE_ITEM_STATE </td><td class="fielddoc"><p>Expect an item of a flow sequence. </p> </td></tr> <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721ab811f3d642dacc7c413af2c32356f894"></a>YAML_EMIT_FLOW_MAPPING_FIRST_KEY_STATE </td><td class="fielddoc"><p>Expect the first key of a flow mapping. </p> </td></tr> <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721ababf835ee5cd4c6de2231e2a49e40626"></a>YAML_EMIT_FLOW_MAPPING_KEY_STATE </td><td class="fielddoc"><p>Expect a key of a flow mapping. </p> </td></tr> <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721aa6f687a6b57e727f0e7b7a2687ad7383"></a>YAML_EMIT_FLOW_MAPPING_SIMPLE_VALUE_STATE </td><td class="fielddoc"><p>Expect a value for a simple key of a flow mapping. </p> </td></tr> <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721acb6dbcb535248b8fde779aeedc957b2e"></a>YAML_EMIT_FLOW_MAPPING_VALUE_STATE </td><td class="fielddoc"><p>Expect a value of a flow mapping. </p> </td></tr> <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721a68af7c090c6d0187788e390341f0cc4d"></a>YAML_EMIT_BLOCK_SEQUENCE_FIRST_ITEM_STATE </td><td class="fielddoc"><p>Expect the first item of a block sequence. </p> </td></tr> <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721a8197c180c3cefee7b67304e17b52c5ff"></a>YAML_EMIT_BLOCK_SEQUENCE_ITEM_STATE </td><td class="fielddoc"><p>Expect an item of a block sequence. </p> </td></tr> <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721aee36d46c1facecfd73fab73e3343226e"></a>YAML_EMIT_BLOCK_MAPPING_FIRST_KEY_STATE </td><td class="fielddoc"><p>Expect the first key of a block mapping. </p> </td></tr> <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721a58495cae63b8c3d7c389b1281baeec05"></a>YAML_EMIT_BLOCK_MAPPING_KEY_STATE </td><td class="fielddoc"><p>Expect the key of a block mapping. </p> </td></tr> <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721a4aa3c6bf2f2d976c47289c741d7a8704"></a>YAML_EMIT_BLOCK_MAPPING_SIMPLE_VALUE_STATE </td><td class="fielddoc"><p>Expect a value for a simple key of a block mapping. </p> </td></tr> <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721a7e0f7fac64fc64bb2bc9fe2ec93ca564"></a>YAML_EMIT_BLOCK_MAPPING_VALUE_STATE </td><td class="fielddoc"><p>Expect a value of a block mapping. </p> </td></tr> <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721a2a0232912eaf4eeb06594ee6157dfbc0"></a>YAML_EMIT_END_STATE </td><td class="fielddoc"><p>Expect nothing. </p> </td></tr> </table> <p class="definition">Definition at line <a class="el" href="../../dc/dfe/yaml_8h_source.html#l01479">1479</a> of file <a class="el" href="../../dc/dfe/yaml_8h_source.html">yaml.h</a>.</p> </div> </div> <h2 class="groupheader">Function Documentation</h2> <a id="ga0bb06e65d52d245546da60bcb4d86ef8"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga0bb06e65d52d245546da60bcb4d86ef8">◆ </a></span>yaml_emitter_close()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">yaml_emitter_close </td> <td>(</td> <td class="paramtype"><a class="el" href="../../dc/d26/group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td> <td class="paramname"><em>emitter</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Finish a YAML stream. </p> <p>This function should be used after <a class="el" href="../../dc/d26/group__emitter.html#gad83d36124da2cd7ccc5c3206b8c00667" title="Emit a YAML document. ">yaml_emitter_dump()</a> is called.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> <p class="definition">Definition at line <a class="el" href="../../db/d2b/dumper_8c_source.html#l00086">86</a> of file <a class="el" href="../../db/d2b/dumper_8c_source.html">dumper.c</a>.</p> <p class="reference">References <a class="el" href="../../d5/dac/ossl_8h_source.html#l00045">assert</a>, <a class="el" href="../../d4/d54/psych__parser_8c_source.html#l00523">mark()</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00559">STREAM_END_EVENT_INIT</a>, and <a class="el" href="../../da/d1b/emitter_8c_source.html#l00281">yaml_emitter_emit()</a>.</p> <p class="reference">Referenced by <a class="el" href="../../db/d2b/dumper_8c_source.html#l00112">yaml_emitter_dump()</a>.</p> </div> </div> <a id="ga022057d354df49b2ba201ec2112fdfbf"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga022057d354df49b2ba201ec2112fdfbf">◆ </a></span>yaml_emitter_delete()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">yaml_emitter_delete </td> <td>(</td> <td class="paramtype"><a class="el" href="../../dc/d26/group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td> <td class="paramname"><em>emitter</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Destroy an emitter. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr> </table> </dd> </dl> <p class="definition">Definition at line <a class="el" href="../../d3/de3/api_8c_source.html#l00386">386</a> of file <a class="el" href="../../d3/de3/api_8c_source.html">api.c</a>.</p> <p class="reference">References <a class="el" href="../../d5/dac/ossl_8h_source.html#l00045">assert</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00103">BUFFER_DEL</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00484">DEQUEUE</a>, <a class="el" href="../../dc/dfe/yaml_8h_source.html#l00091">yaml_tag_directive_s::handle</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00457">POP</a>, <a class="el" href="../../dc/dfe/yaml_8h_source.html#l00093">yaml_tag_directive_s::prefix</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00468">QUEUE_DEL</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00472">QUEUE_EMPTY</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00434">STACK_DEL</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00438">STACK_EMPTY</a>, <a class="el" href="../../d3/de3/api_8c_source.html#l00983">yaml_event_delete()</a>, and <a class="el" href="../../d3/de3/api_8c_source.html#l00051">yaml_free()</a>.</p> <p class="reference">Referenced by <a class="el" href="../../d3/d42/psych__emitter_8c_source.html#l00023">dealloc()</a>.</p> </div> </div> <a id="gad83d36124da2cd7ccc5c3206b8c00667"></a> <h2 class="memtitle"><span class="permalink"><a href="#gad83d36124da2cd7ccc5c3206b8c00667">◆ </a></span>yaml_emitter_dump()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">yaml_emitter_dump </td> <td>(</td> <td class="paramtype"><a class="el" href="../../dc/d26/group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td> <td class="paramname"><em>emitter</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="../../dd/d58/group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> * </td> <td class="paramname"><em>document</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Emit a YAML document. </p> <p>The documen object may be generated using the <a class="el" href="../../dd/da8/group__parser.html#gafe5381d911f9dab9683dd27676f50336" title="Parse the input stream and produce the next YAML document. ">yaml_parser_load()</a> function or the <a class="el" href="../../dd/d58/group__nodes.html#ga85eed8be65e6e200a594bf4e04beda2c" title="Create a YAML document. ">yaml_document_initialize()</a> function. The emitter takes the responsibility for the document object and destoys its content after it is emitted. The document object is destroyedeven if the function fails.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr> <tr><td class="paramdir">[in,out]</td><td class="paramname">document</td><td>A document object.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> <p class="definition">Definition at line <a class="el" href="../../db/d2b/dumper_8c_source.html#l00112">112</a> of file <a class="el" href="../../db/d2b/dumper_8c_source.html">dumper.c</a>.</p> <p class="reference">References <a class="el" href="../../d5/dac/ossl_8h_source.html#l00045">assert</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00570">DOCUMENT_END_EVENT_INIT</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00562">DOCUMENT_START_EVENT_INIT</a>, <a class="el" href="../../d4/d54/psych__parser_8c_source.html#l00523">mark()</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00438">STACK_EMPTY</a>, <a class="el" href="../../dc/dfe/yaml_8h_source.html#l00401">yaml_event_s::version_directive</a>, <a class="el" href="../../db/d2b/dumper_8c_source.html#l00207">yaml_emitter_anchor_node()</a>, <a class="el" href="../../db/d2b/dumper_8c_source.html#l00086">yaml_emitter_close()</a>, <a class="el" href="../../db/d2b/dumper_8c_source.html#l00167">yaml_emitter_delete_document_and_anchors()</a>, <a class="el" href="../../db/d2b/dumper_8c_source.html#l00264">yaml_emitter_dump_node()</a>, <a class="el" href="../../da/d1b/emitter_8c_source.html#l00281">yaml_emitter_emit()</a>, <a class="el" href="../../db/d2b/dumper_8c_source.html#l00062">yaml_emitter_open()</a>, and <a class="el" href="../../d3/de3/api_8c_source.html#l00031">yaml_malloc()</a>.</p> </div> </div> <a id="ga674387bc34a739a655f5275176494234"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga674387bc34a739a655f5275176494234">◆ </a></span>yaml_emitter_emit()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">yaml_emitter_emit </td> <td>(</td> <td class="paramtype"><a class="el" href="../../dc/d26/group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td> <td class="paramname"><em>emitter</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="../../d1/ddf/group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> * </td> <td class="paramname"><em>event</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Emit an event. </p> <p>The event object may be generated using the <a class="el" href="../../dd/da8/group__parser.html#gaa90105acba29cbf17b287e5c41c48dde" title="Parse the input stream and produce the next parsing event. ">yaml_parser_parse()</a> function. The emitter takes the responsibility for the event object and destroys its content after it is emitted. The event object is destroyed even if the function fails.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr> <tr><td class="paramdir">[in,out]</td><td class="paramname">event</td><td>An event object.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> <p class="definition">Definition at line <a class="el" href="../../da/d1b/emitter_8c_source.html#l00281">281</a> of file <a class="el" href="../../da/d1b/emitter_8c_source.html">emitter.c</a>.</p> <p class="reference">References <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00484">DEQUEUE</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00475">ENQUEUE</a>, <a class="el" href="../../da/d1b/emitter_8c_source.html#l01679">yaml_emitter_analyze_event()</a>, <a class="el" href="../../da/d1b/emitter_8c_source.html#l00309">yaml_emitter_need_more_events()</a>, <a class="el" href="../../da/d1b/emitter_8c_source.html#l00424">yaml_emitter_state_machine()</a>, and <a class="el" href="../../d3/de3/api_8c_source.html#l00983">yaml_event_delete()</a>.</p> <p class="reference">Referenced by <a class="el" href="../../d3/d42/psych__emitter_8c_source.html#l00009">emit()</a>, <a class="el" href="../../db/d2b/dumper_8c_source.html#l00086">yaml_emitter_close()</a>, <a class="el" href="../../db/d2b/dumper_8c_source.html#l00112">yaml_emitter_dump()</a>, <a class="el" href="../../db/d2b/dumper_8c_source.html#l00301">yaml_emitter_dump_alias()</a>, <a class="el" href="../../db/d2b/dumper_8c_source.html#l00369">yaml_emitter_dump_mapping()</a>, <a class="el" href="../../db/d2b/dumper_8c_source.html#l00316">yaml_emitter_dump_scalar()</a>, <a class="el" href="../../db/d2b/dumper_8c_source.html#l00339">yaml_emitter_dump_sequence()</a>, and <a class="el" href="../../db/d2b/dumper_8c_source.html#l00062">yaml_emitter_open()</a>.</p> </div> </div> <a id="gab81b1e07666bbefe0815e7aa05d01d19"></a> <h2 class="memtitle"><span class="permalink"><a href="#gab81b1e07666bbefe0815e7aa05d01d19">◆ </a></span>yaml_emitter_flush()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">yaml_emitter_flush </td> <td>(</td> <td class="paramtype"><a class="el" href="../../dc/d26/group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td> <td class="paramname"><em>emitter</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Flush the accumulated characters to the output. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> <p class="definition">Definition at line <a class="el" href="../../d6/d42/writer_8c_source.html#l00032">32</a> of file <a class="el" href="../../d6/d42/writer_8c_source.html">writer.c</a>.</p> <p class="reference">References <a class="el" href="../../d5/dac/ossl_8h_source.html#l00045">assert</a>, <a class="el" href="../../d6/d42/writer_8c_source.html#l00019">yaml_emitter_set_writer_error()</a>, <a class="el" href="../../dc/dfe/yaml_8h_source.html#l00103">YAML_UTF16LE_ENCODING</a>, and <a class="el" href="../../dc/dfe/yaml_8h_source.html#l00101">YAML_UTF8_ENCODING</a>.</p> <p class="reference">Referenced by <a class="el" href="../../da/d1b/emitter_8c_source.html#l00691">yaml_emitter_emit_document_end()</a>, and <a class="el" href="../../da/d1b/emitter_8c_source.html#l00551">yaml_emitter_emit_document_start()</a>.</p> </div> </div> <a id="gac8a99a6fd575f601fd5c9c65a491ea45"></a> <h2 class="memtitle"><span class="permalink"><a href="#gac8a99a6fd575f601fd5c9c65a491ea45">◆ </a></span>yaml_emitter_initialize()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">yaml_emitter_initialize </td> <td>(</td> <td class="paramtype"><a class="el" href="../../dc/d26/group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td> <td class="paramname"><em>emitter</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Initialize an emitter. </p> <p>This function creates a new emitter object. An application is responsible for destroying the object using the <a class="el" href="../../dc/d26/group__emitter.html#ga022057d354df49b2ba201ec2112fdfbf" title="Destroy an emitter. ">yaml_emitter_delete()</a> function.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[out]</td><td class="paramname">emitter</td><td>An empty parser object.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> <p class="definition">Definition at line <a class="el" href="../../d3/de3/api_8c_source.html#l00349">349</a> of file <a class="el" href="../../d3/de3/api_8c_source.html">api.c</a>.</p> <p class="reference">References <a class="el" href="../../d5/dac/ossl_8h_source.html#l00045">assert</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00103">BUFFER_DEL</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00095">BUFFER_INIT</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00088">INITIAL_QUEUE_SIZE</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00087">INITIAL_STACK_SIZE</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00073">OUTPUT_BUFFER_SIZE</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00081">OUTPUT_RAW_BUFFER_SIZE</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00468">QUEUE_DEL</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00460">QUEUE_INIT</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00434">STACK_DEL</a>, and <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00426">STACK_INIT</a>.</p> <p class="reference">Referenced by <a class="el" href="../../d3/d42/psych__emitter_8c_source.html#l00032">allocate()</a>.</p> </div> </div> <a id="ga2196ff07f4c8fe9e4bbe0dbab69c42ef"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga2196ff07f4c8fe9e4bbe0dbab69c42ef">◆ </a></span>yaml_emitter_open()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">yaml_emitter_open </td> <td>(</td> <td class="paramtype"><a class="el" href="../../dc/d26/group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td> <td class="paramname"><em>emitter</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Start a YAML stream. </p> <p>This function should be used before <a class="el" href="../../dc/d26/group__emitter.html#gad83d36124da2cd7ccc5c3206b8c00667" title="Emit a YAML document. ">yaml_emitter_dump()</a> is called.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> <p class="definition">Definition at line <a class="el" href="../../db/d2b/dumper_8c_source.html#l00062">62</a> of file <a class="el" href="../../db/d2b/dumper_8c_source.html">dumper.c</a>.</p> <p class="reference">References <a class="el" href="../../d5/dac/ossl_8h_source.html#l00045">assert</a>, <a class="el" href="../../d4/d54/psych__parser_8c_source.html#l00523">mark()</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00555">STREAM_START_EVENT_INIT</a>, <a class="el" href="../../dc/dfe/yaml_8h_source.html#l00099">YAML_ANY_ENCODING</a>, and <a class="el" href="../../da/d1b/emitter_8c_source.html#l00281">yaml_emitter_emit()</a>.</p> <p class="reference">Referenced by <a class="el" href="../../db/d2b/dumper_8c_source.html#l00112">yaml_emitter_dump()</a>.</p> </div> </div> <a id="ga44ec73ce330ee875c41a985cffa88ce7"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga44ec73ce330ee875c41a985cffa88ce7">◆ </a></span>yaml_emitter_set_break()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">yaml_emitter_set_break </td> <td>(</td> <td class="paramtype"><a class="el" href="../../dc/d26/group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td> <td class="paramname"><em>emitter</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="../../d0/df6/group__basic.html#ga64d1365e1acd4deeab50d6b48e39cb6d">yaml_break_t</a> </td> <td class="paramname"><em>line_break</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Set the preferred line break. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">line_break</td><td>The preferred line break. </td></tr> </table> </dd> </dl> <p class="definition">Definition at line <a class="el" href="../../d3/de3/api_8c_source.html#l00566">566</a> of file <a class="el" href="../../d3/de3/api_8c_source.html">api.c</a>.</p> <p class="reference">References <a class="el" href="../../d5/dac/ossl_8h_source.html#l00045">assert</a>.</p> </div> </div> <a id="ga4126fff1d9f3bc9cbd9b6abe1c7bf300"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga4126fff1d9f3bc9cbd9b6abe1c7bf300">◆ </a></span>yaml_emitter_set_canonical()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">yaml_emitter_set_canonical </td> <td>(</td> <td class="paramtype"><a class="el" href="../../dc/d26/group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td> <td class="paramname"><em>emitter</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>canonical</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Set if the output should be in the "canonical" format as in the YAML specification. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">canonical</td><td>If the output is canonical. </td></tr> </table> </dd> </dl> <p class="definition">Definition at line <a class="el" href="../../d3/de3/api_8c_source.html#l00518">518</a> of file <a class="el" href="../../d3/de3/api_8c_source.html">api.c</a>.</p> <p class="reference">References <a class="el" href="../../d5/dac/ossl_8h_source.html#l00045">assert</a>, and <a class="el" href="../../d3/d42/psych__emitter_8c_source.html#l00446">canonical()</a>.</p> <p class="reference">Referenced by <a class="el" href="../../d3/d42/psych__emitter_8c_source.html#l00049">initialize()</a>, and <a class="el" href="../../d3/d42/psych__emitter_8c_source.html#l00432">set_canonical()</a>.</p> </div> </div> <a id="ga6f460de132f4059a6e026a046ffd973a"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga6f460de132f4059a6e026a046ffd973a">◆ </a></span>yaml_emitter_set_encoding()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">yaml_emitter_set_encoding </td> <td>(</td> <td class="paramtype"><a class="el" href="../../dc/d26/group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td> <td class="paramname"><em>emitter</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="../../d0/df6/group__basic.html#ga2170996d7e636397b5e6bc0c1b7df7c6">yaml_encoding_t</a> </td> <td class="paramname"><em>encoding</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Set the output encoding. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">encoding</td><td>The output encoding. </td></tr> </table> </dd> </dl> <p class="definition">Definition at line <a class="el" href="../../d3/de3/api_8c_source.html#l00505">505</a> of file <a class="el" href="../../d3/de3/api_8c_source.html">api.c</a>.</p> <p class="reference">References <a class="el" href="../../d5/dac/ossl_8h_source.html#l00045">assert</a>.</p> </div> </div> <a id="ga1755922448720fa0fdb5fd6fb04fe2b1"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga1755922448720fa0fdb5fd6fb04fe2b1">◆ </a></span>yaml_emitter_set_indent()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">yaml_emitter_set_indent </td> <td>(</td> <td class="paramtype"><a class="el" href="../../dc/d26/group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td> <td class="paramname"><em>emitter</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>indent</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Set the indentation increment. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">indent</td><td>The indentation increment (1 < . < 10). </td></tr> </table> </dd> </dl> <p class="definition">Definition at line <a class="el" href="../../d3/de3/api_8c_source.html#l00530">530</a> of file <a class="el" href="../../d3/de3/api_8c_source.html">api.c</a>.</p> <p class="reference">References <a class="el" href="../../d5/dac/ossl_8h_source.html#l00045">assert</a>.</p> <p class="reference">Referenced by <a class="el" href="../../d3/d42/psych__emitter_8c_source.html#l00032">allocate()</a>, <a class="el" href="../../d3/d42/psych__emitter_8c_source.html#l00049">initialize()</a>, and <a class="el" href="../../d3/d42/psych__emitter_8c_source.html#l00459">set_indentation()</a>.</p> </div> </div> <a id="gac02a763e0905749817cceab92b527699"></a> <h2 class="memtitle"><span class="permalink"><a href="#gac02a763e0905749817cceab92b527699">◆ </a></span>yaml_emitter_set_output()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">yaml_emitter_set_output </td> <td>(</td> <td class="paramtype"><a class="el" href="../../dc/d26/group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td> <td class="paramname"><em>emitter</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="../../dc/d26/group__emitter.html#ga1669659aacbe631ad406c78fce1f5379">yaml_write_handler_t</a> * </td> <td class="paramname"><em>handler</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">void * </td> <td class="paramname"><em>data</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Set a generic output handler. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">handler</td><td>A write handler. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Any application data for passing to the write handler. </td></tr> </table> </dd> </dl> <p class="definition">Definition at line <a class="el" href="../../d3/de3/api_8c_source.html#l00489">489</a> of file <a class="el" href="../../d3/de3/api_8c_source.html">api.c</a>.</p> <p class="reference">References <a class="el" href="../../d5/dac/ossl_8h_source.html#l00045">assert</a>.</p> <p class="reference">Referenced by <a class="el" href="../../d3/d42/psych__emitter_8c_source.html#l00049">initialize()</a>.</p> </div> </div> <a id="gac9aa105b8c90fc0550dbabaa83ab0984"></a> <h2 class="memtitle"><span class="permalink"><a href="#gac9aa105b8c90fc0550dbabaa83ab0984">◆ </a></span>yaml_emitter_set_output_file()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">yaml_emitter_set_output_file </td> <td>(</td> <td class="paramtype"><a class="el" href="../../dc/d26/group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td> <td class="paramname"><em>emitter</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="../../da/d50/vsnprintf_8c.html#a95742987b07c3bc61a7f376b0168410b">FILE</a> * </td> <td class="paramname"><em>file</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Set a file output. </p> <p><em>file</em> should be a file object open for writing. The application is responsible for closing the <em>file</em>.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>An open file. </td></tr> </table> </dd> </dl> <p class="definition">Definition at line <a class="el" href="../../d3/de3/api_8c_source.html#l00472">472</a> of file <a class="el" href="../../d3/de3/api_8c_source.html">api.c</a>.</p> <p class="reference">References <a class="el" href="../../d5/dac/ossl_8h_source.html#l00045">assert</a>, and <a class="el" href="../../d3/de3/api_8c_source.html#l00440">yaml_file_write_handler()</a>.</p> </div> </div> <a id="gabfaf23e894ddf79c4cdeacd512e61d08"></a> <h2 class="memtitle"><span class="permalink"><a href="#gabfaf23e894ddf79c4cdeacd512e61d08">◆ </a></span>yaml_emitter_set_output_string()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">yaml_emitter_set_output_string </td> <td>(</td> <td class="paramtype"><a class="el" href="../../dc/d26/group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td> <td class="paramname"><em>emitter</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned char * </td> <td class="paramname"><em>output</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"><em>size</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t * </td> <td class="paramname"><em>size_written</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Set a string output. </p> <p>The emitter will write the output characters to the <em>output</em> buffer of the size <em>size</em>. The emitter will set <em>size_written</em> to the number of written bytes. If the buffer is smaller than required, the emitter produces the YAML_WRITE_ERROR error.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">output</td><td>An output buffer. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The buffer size. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">size_written</td><td>The pointer to save the number of written bytes. </td></tr> </table> </dd> </dl> <p class="definition">Definition at line <a class="el" href="../../d3/de3/api_8c_source.html#l00451">451</a> of file <a class="el" href="../../d3/de3/api_8c_source.html">api.c</a>.</p> <p class="reference">References <a class="el" href="../../d5/dac/ossl_8h_source.html#l00045">assert</a>, <a class="el" href="../../d8/d90/nkf_8c_source.html#l00032">output</a>, <a class="el" href="../../d5/db5/encoding_8c_source.html#l00049">size</a>, and <a class="el" href="../../d3/de3/api_8c_source.html#l00414">yaml_string_write_handler()</a>.</p> </div> </div> <a id="ga4e06d64888a25f32138b2e929d0e9543"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga4e06d64888a25f32138b2e929d0e9543">◆ </a></span>yaml_emitter_set_unicode()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">yaml_emitter_set_unicode </td> <td>(</td> <td class="paramtype"><a class="el" href="../../dc/d26/group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td> <td class="paramname"><em>emitter</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>unicode</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Set if unescaped non-ASCII characters are allowed. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">unicode</td><td>If unescaped Unicode characters are allowed. </td></tr> </table> </dd> </dl> <p class="definition">Definition at line <a class="el" href="../../d3/de3/api_8c_source.html#l00554">554</a> of file <a class="el" href="../../d3/de3/api_8c_source.html">api.c</a>.</p> <p class="reference">References <a class="el" href="../../d5/dac/ossl_8h_source.html#l00045">assert</a>.</p> <p class="reference">Referenced by <a class="el" href="../../d3/d42/psych__emitter_8c_source.html#l00032">allocate()</a>.</p> </div> </div> <a id="ga7d8943ef1c1ba237e77c6d7b6928bee5"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga7d8943ef1c1ba237e77c6d7b6928bee5">◆ </a></span>yaml_emitter_set_width()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">yaml_emitter_set_width </td> <td>(</td> <td class="paramtype"><a class="el" href="../../dc/d26/group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td> <td class="paramname"><em>emitter</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>width</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Set the preferred line width. </p> <p><code>-1</code> means unlimited.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">width</td><td>The preferred line width. </td></tr> </table> </dd> </dl> <p class="definition">Definition at line <a class="el" href="../../d3/de3/api_8c_source.html#l00542">542</a> of file <a class="el" href="../../d3/de3/api_8c_source.html">api.c</a>.</p> <p class="reference">References <a class="el" href="../../d5/dac/ossl_8h_source.html#l00045">assert</a>.</p> <p class="reference">Referenced by <a class="el" href="../../d3/d42/psych__emitter_8c_source.html#l00049">initialize()</a>, and <a class="el" href="../../d3/d42/psych__emitter_8c_source.html#l00497">set_line_width()</a>.</p> </div> </div> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="../../doxygen.png" alt="doxygen"/> </a> 1.8.14 </small></address> </body> </html>
💾 Save Changes
❌ Cancel