blob: 6657b885783af7b2611a04b4d02d7dd3b9128144 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.18"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Crashpad: crashpad::Base94OutputStream Class Reference</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="crashpad_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">Crashpad
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.18 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<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&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacecrashpad.html">crashpad</a></li><li class="navelem"><a class="el" href="classcrashpad_1_1Base94OutputStream.html">Base94OutputStream</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classcrashpad_1_1Base94OutputStream-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">crashpad::Base94OutputStream Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This class implements Base94 encoding/decoding, it uses all printable characters except space for encoding, and no padding is required.
<a href="classcrashpad_1_1Base94OutputStream.html#details">More...</a></p>
<p><code>#include &quot;util/stream/base94_output_stream.h&quot;</code></p>
<div class="dynheader">
Inheritance diagram for crashpad::Base94OutputStream:</div>
<div class="dyncontent">
<div class="center">
<img src="classcrashpad_1_1Base94OutputStream.png" alt=""/>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:aa8ee87017ef9ac5d4a00eca42051605f"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1Base94OutputStream.html#aa8ee87017ef9ac5d4a00eca42051605f">Mode</a> : bool </td></tr>
<tr class="memdesc:aa8ee87017ef9ac5d4a00eca42051605f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether this object is configured to encode or decode data. <a href="classcrashpad_1_1Base94OutputStream.html#aa8ee87017ef9ac5d4a00eca42051605f">More...</a><br /></td></tr>
<tr class="separator:aa8ee87017ef9ac5d4a00eca42051605f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a299213bb678a7cfc079a99e8e8476f6e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1Base94OutputStream.html#a299213bb678a7cfc079a99e8e8476f6e">Base94OutputStream</a> (<a class="el" href="classcrashpad_1_1Base94OutputStream.html#aa8ee87017ef9ac5d4a00eca42051605f">Mode</a> mode, std::unique_ptr&lt; OutputStreamInterface &gt; output_stream)</td></tr>
<tr class="separator:a299213bb678a7cfc079a99e8e8476f6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33ebdbfb36ecb3e7077230112ce6341b"><td class="memItemLeft" align="right" valign="top"><a id="a33ebdbfb36ecb3e7077230112ce6341b"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>Write</b> (const uint8_t *data, size_t size) override</td></tr>
<tr class="separator:a33ebdbfb36ecb3e7077230112ce6341b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a62ae370e98cb028743a8346634bbe7c7"><td class="memItemLeft" align="right" valign="top"><a id="a62ae370e98cb028743a8346634bbe7c7"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>Flush</b> () override</td></tr>
<tr class="separator:a62ae370e98cb028743a8346634bbe7c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class implements Base94 encoding/decoding, it uses all printable characters except space for encoding, and no padding is required. </p>
<p>This implementation uses two base94 symbols to encoding 13 or 14 bit data, To maximize encoding efficiency, 14-bit data is encoded into two base94 symbols if its low 13-bit is less than 644 ( = 94^2 - 2^13), otherwise 13-bit data is encoded. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="aa8ee87017ef9ac5d4a00eca42051605f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8ee87017ef9ac5d4a00eca42051605f">&#9670;&nbsp;</a></span>Mode</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classcrashpad_1_1Base94OutputStream.html#aa8ee87017ef9ac5d4a00eca42051605f">crashpad::Base94OutputStream::Mode</a> : bool</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Whether this object is configured to encode or decode data. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aa8ee87017ef9ac5d4a00eca42051605fa9e0079b93f730c214bdb28464bf1fd42"></a>kEncode&#160;</td><td class="fielddoc"><p>Data passed through this object is encoded. </p>
</td></tr>
<tr><td class="fieldname"><a id="aa8ee87017ef9ac5d4a00eca42051605fa0759563eb393912452c9ff3d64899760"></a>kDecode&#160;</td><td class="fielddoc"><p>Data passed through this object is decoded. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a299213bb678a7cfc079a99e8e8476f6e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a299213bb678a7cfc079a99e8e8476f6e">&#9670;&nbsp;</a></span>Base94OutputStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">crashpad::Base94OutputStream::Base94OutputStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classcrashpad_1_1Base94OutputStream.html#aa8ee87017ef9ac5d4a00eca42051605f">Mode</a>&#160;</td>
<td class="paramname"><em>mode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::unique_ptr&lt; OutputStreamInterface &gt;&#160;</td>
<td class="paramname"><em>output_stream</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>The work mode of this object. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">output_stream</td><td>The output_stream that this object writes to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>util/stream/base94_output_stream.h</li>
<li>util/stream/base94_output_stream.cc</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.18
</small></address>
</body>
</html>