| <!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::FileEncoder 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&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&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_1FileEncoder.html">FileEncoder</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-types">Public Types</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classcrashpad_1_1FileEncoder-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">crashpad::FileEncoder Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>The class is used to compress and base94-encode, or base94-decode and decompress the given input file to the output file. |
| <a href="classcrashpad_1_1FileEncoder.html#details">More...</a></p> |
| |
| <p><code>#include "util/stream/file_encoder.h"</code></p> |
| <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:ab6474236112a804391ff41245cce81e3"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1FileEncoder.html#ab6474236112a804391ff41245cce81e3">Mode</a> : bool </td></tr> |
| <tr class="memdesc:ab6474236112a804391ff41245cce81e3"><td class="mdescLeft"> </td><td class="mdescRight">Whether this object is configured to encode or decode data. <a href="classcrashpad_1_1FileEncoder.html#ab6474236112a804391ff41245cce81e3">More...</a><br /></td></tr> |
| <tr class="separator:ab6474236112a804391ff41245cce81e3"><td class="memSeparator" colspan="2"> </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:a802d616e93ae90952475e9370cd5b46b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1FileEncoder.html#a802d616e93ae90952475e9370cd5b46b">FileEncoder</a> (<a class="el" href="classcrashpad_1_1FileEncoder.html#ab6474236112a804391ff41245cce81e3">Mode</a> mode, const base::FilePath &input_path, const base::FilePath &output_path)</td></tr> |
| <tr class="separator:a802d616e93ae90952475e9370cd5b46b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aeec354fc723b1a8713a46e09b8623637"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1FileEncoder.html#aeec354fc723b1a8713a46e09b8623637">Process</a> ()</td></tr> |
| <tr class="memdesc:aeec354fc723b1a8713a46e09b8623637"><td class="mdescLeft"> </td><td class="mdescRight">Encode/decode the data from <em>input_path_</em> file according work <em>mode</em>, and write the result to <em>output_path_</em> on success. <a href="classcrashpad_1_1FileEncoder.html#aeec354fc723b1a8713a46e09b8623637">More...</a><br /></td></tr> |
| <tr class="separator:aeec354fc723b1a8713a46e09b8623637"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>The class is used to compress and base94-encode, or base94-decode and decompress the given input file to the output file. </p> |
| </div><h2 class="groupheader">Member Enumeration Documentation</h2> |
| <a id="ab6474236112a804391ff41245cce81e3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab6474236112a804391ff41245cce81e3">◆ </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_1FileEncoder.html#ab6474236112a804391ff41245cce81e3">crashpad::FileEncoder::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="ab6474236112a804391ff41245cce81e3a9e0079b93f730c214bdb28464bf1fd42"></a>kEncode </td><td class="fielddoc"><p>Data passed through this object is encoded. </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="ab6474236112a804391ff41245cce81e3a0759563eb393912452c9ff3d64899760"></a>kDecode </td><td class="fielddoc"><p>Data passed through this object is decoded. </p> |
| </td></tr> |
| </table> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a802d616e93ae90952475e9370cd5b46b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a802d616e93ae90952475e9370cd5b46b">◆ </a></span>FileEncoder()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">crashpad::FileEncoder::FileEncoder </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classcrashpad_1_1FileEncoder.html#ab6474236112a804391ff41245cce81e3">Mode</a> </td> |
| <td class="paramname"><em>mode</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const base::FilePath & </td> |
| <td class="paramname"><em>input_path</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const base::FilePath & </td> |
| <td class="paramname"><em>output_path</em> </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">input_path</td><td>The input file that this object reads from. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">output_path</td><td>The output file that this object writes to. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="aeec354fc723b1a8713a46e09b8623637"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aeec354fc723b1a8713a46e09b8623637">◆ </a></span>Process()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool crashpad::FileEncoder::Process </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Encode/decode the data from <em>input_path_</em> file according work <em>mode</em>, and write the result to <em>output_path_</em> on success. </p> |
| <dl class="section return"><dt>Returns</dt><dd><code>true</code> on success. </dd></dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following files:<ul> |
| <li>util/stream/file_encoder.h</li> |
| <li>util/stream/file_encoder.cc</li> |
| </ul> |
| </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.18 |
| </small></address> |
| </body> |
| </html> |
