3party/crashpad
0
0
Fork 0
mirror of https://github.com/chromium/crashpad.git synced 2025-03-21 11:13:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
crashpad/doc/generated/doxygen/classcrashpad_1_1internal_1_1ReadExactlyInternal.html

142 lines
7.9 KiB
HTML
Raw Normal View History

Update documentation to master 3983b80ca2fc
2017-03-21 22:35:30 -04:00
<!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"/>
Update documentation to master 6759969bf653
2018-08-01 13:34:49 -04:00
<meta name="generator" content="Doxygen 1.8.14"/>
Update documentation to master 3983b80ca2fc
2017-03-21 22:35:30 -04:00
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Crashpad: crashpad::internal::ReadExactlyInternal 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 -->
Update documentation to master 6759969bf653
2018-08-01 13:34:49 -04:00
<!-- Generated by Doxygen 1.8.14 -->
Update documentation to master 3983b80ca2fc
2017-03-21 22:35:30 -04:00
<script type="text/javascript">
Update documentation to master 6759969bf653
2018-08-01 13:34:49 -04:00
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
Update documentation to master 3983b80ca2fc
2017-03-21 22:35:30 -04:00
var searchBox = new SearchBox("searchBox", "search",false,'Search');
Update documentation to master 6759969bf653
2018-08-01 13:34:49 -04:00
/* @license-end */
Update documentation to master 3983b80ca2fc
2017-03-21 22:35:30 -04:00
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
Update documentation to master 6759969bf653
2018-08-01 13:34:49 -04:00
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
Update documentation to master 3983b80ca2fc
2017-03-21 22:35:30 -04:00
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
Update documentation to master 6759969bf653
2018-08-01 13:34:49 -04:00
/* @license-end */</script>
Update documentation to master 3983b80ca2fc
2017-03-21 22:35:30 -04:00
<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="namespacecrashpad_1_1internal.html">internal</a></li><li class="navelem"><a class="el" href="classcrashpad_1_1internal_1_1ReadExactlyInternal.html">ReadExactlyInternal</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classcrashpad_1_1internal_1_1ReadExactlyInternal-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">crashpad::internal::ReadExactlyInternal Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>The internal implementation of <a class="el" href="namespacecrashpad.html#a6e685af255d9b71fb46ed2679329dd7c" title="Wraps ReadFile(), retrying following a short read, ensuring that exactly size bytes are read...">ReadFileExactly()</a> and its wrappers.
<a href="classcrashpad_1_1internal_1_1ReadExactlyInternal.html#details">More...</a></p>
<p><code>#include &quot;util/file/file_io.h&quot;</code></p>
<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:a964b12b0f1f74cd061148a8001fab077"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1ReadExactlyInternal.html#a964b12b0f1f74cd061148a8001fab077">ReadExactly</a> (void *buffer, size_t size, bool can_log)</td></tr>
<tr class="memdesc:a964b12b0f1f74cd061148a8001fab077"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calls Read(), retrying following a short read, ensuring that exactly <em>size</em> bytes are read. <a href="#a964b12b0f1f74cd061148a8001fab077">More...</a><br /></td></tr>
<tr class="separator:a964b12b0f1f74cd061148a8001fab077"><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>The internal implementation of <a class="el" href="namespacecrashpad.html#a6e685af255d9b71fb46ed2679329dd7c" title="Wraps ReadFile(), retrying following a short read, ensuring that exactly size bytes are read...">ReadFileExactly()</a> and its wrappers. </p>
<p>The logic is exposed so that it may be reused by <a class="el" href="classcrashpad_1_1FileReaderInterface.html" title="An interface to read to files and other file-like objects with semantics matching the underlying plat...">FileReaderInterface</a>, and so that it may be tested without requiring large files to be read. It is not intended to be used more generally. Use <a class="el" href="namespacecrashpad.html#a6e685af255d9b71fb46ed2679329dd7c" title="Wraps ReadFile(), retrying following a short read, ensuring that exactly size bytes are read...">ReadFileExactly()</a>, <a class="el" href="namespacecrashpad.html#ac3fb8955565f605e08c1e30562fbdb7a" title="Wraps ReadFile(), retrying following a short read, ensuring that exactly size bytes are read...">LoggingReadFileExactly()</a>, <a class="el" href="namespacecrashpad.html#a00e03e19185b0fde6301be6b113628cb" title="Wraps ReadFile(), ensuring that exactly size bytes are read. ">CheckedReadFileExactly()</a>, or <a class="el" href="classcrashpad_1_1FileReaderInterface.html#ad046f1ebf1071eb6b92a2a8d06c14a56" title="Wraps Read(), ensuring that the read succeeded and exactly size bytes were read. ">FileReaderInterface::ReadExactly()</a> instead. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a964b12b0f1f74cd061148a8001fab077"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a964b12b0f1f74cd061148a8001fab077">&#9670;&nbsp;</a></span>ReadExactly()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool crashpad::internal::ReadExactlyInternal::ReadExactly </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>can_log</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Calls Read(), retrying following a short read, ensuring that exactly <em>size</em> bytes are read. </p>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> on success. <code>false</code> if the underlying Read() fails or if fewer than <em>size</em> bytes were read. When returning <code>false</code>, if <em>can_log</em> is <code>true</code>, logs a message. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>util/file/file_io.h</li>
<li>util/file/file_io.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"/>
Update documentation to master 6759969bf653
2018-08-01 13:34:49 -04:00
</a> 1.8.14
Update documentation to master 3983b80ca2fc
2017-03-21 22:35:30 -04:00
</small></address>
</body>
</html>
Reference in New Issue Copy Permalink