2025-01-15 19:28:55 +01:00

49 lines
7.3 KiB
HTML

<!DOCTYPE html>
<html lang="en"><!-- use theme color or fallback -->
<!--use textcolor from settings, otherwise create a contrasting color to theme color-->
<head><meta charset="utf-8"/><link href="../../bootstrap/css/bootstrap.min.css" rel="stylesheet"/><link href="../../bootstrap/css/bootstrap-responsive.min.css" rel="stylesheet"/><link href="../../bootstrap/css/bootstrap-select.min.css" rel="stylesheet"/><link href="http://fonts.googleapis.com/css?family=Open+Sans:400,700,700italic,400italic" rel="stylesheet" type="text/css"/><link href="http://fonts.googleapis.com/css?family=Source+Sans+Pro:200,600,600italic,400" rel="stylesheet" type="text/css"/><link href="http://netdna.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.css" rel="stylesheet" type="text/css"/><script src="../../jquery-1.9.1.min.js"></script><script src="../../bootstrap/js/bootstrap.min.js"></script><script src="../../bootstrap/js/bootstrap-select.min.js"></script><link href="../../styles.css" rel="stylesheet"/><link href="../../haxe-nav.css" rel="stylesheet"/><script type="text/javascript">var dox = {rootPath: "../../",platforms: ["Neko","Android","Flash","iOS","macOS","Linux","HTML5","Windows"]};</script><script type="text/javascript" src="../../nav.js"></script><script type="text/javascript" src="../../index.js"></script><link rel="icon" href="../../favicon.ico" type="image/x-icon"></link><title>haxe.io.Input - API Reference</title><meta name="description" content="An Input is an abstract reader. See other classes in the &lt;code&gt;haxe.io&lt;/code&gt; package
for several possible implementations."/></head><body><style>
a, code .type {
color: #24afc4;
}
.navbar .brand {
display: inline-block;
float: none;
text-shadow: 0 0 0 transparent;
}
.nav-list>.active>a.treeLink, .nav-list>.active>a.treeLink:hover, .nav-list>.active>a.treeLink:focus {
background: #24afc4;
color: #ffffff;
text-shadow: 0 0 0 transparent;
}
.navbar .container {
width: 940px ;
}
@media (max-width: 767px) {
.navbar .container {
width: auto;
}
}
@media (max-width: 979px) and (min-width: 768px) {
.navbar .container {
width: 724px;
}
}
@media (min-width: 1200px) {
.navbar .container {
width: 1170px;
}
}
.navbar .container img {
margin: 5px 0 0 4px;
}
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#FAFAFA; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" href="http://www.openfl.org"><img alt="" src="http://www.openfl.org/images/logo.png"/></a><a class="brand" style="color:#777777" href="../../">API Reference</a></div></div></div></nav><div class="container main-content"><div class="row-fluid"><div class="span3"><div class="well sidebar-nav"><form class="form-search" id="searchForm"><div class="input-prepend input-block-level"><span class="add-on"><i class="icon-search"></i></span><input id="search" type="text" placeholder="Search" autocomplete="off"/></div></form><div class="dropdown"><select id="select-platform" class="selectpicker" title="Filter by platform" data-width="100%"><option value="all" selected="true">All Platforms</option><option>Neko</option><option>Android</option><option>Flash</option><option>iOS</option><option>macOS</option><option>Linux</option><option>HTML5</option><option>Windows</option></select></div></div><div class="well sidebar-nav"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>class</small> Input</h1><h4><small>package <a href="../../haxe/io/index.html">haxe.io</a></small></h4> <h4><small><span class="muted">extended by </span><a class="type" title="Use sys." href="../../sys/io/FileInput.html">FileInput</a></small></h4><p class="availability"><hr/><em>Available on all platforms</em></p></div><div class="body"><div class="doc doc-main"><div class="indent"><p>An Input is an abstract reader. See other classes in the <code>haxe.io</code> package
for several possible implementations.</p>
<p>All functions which read data throw <code><a href="../../haxe/io/Eof.html">Eof</a></code> when the end of the stream
is reached.</p></div></div><h3 class="section">Methods</h3><div class="fields"><div class="field "><a name="close"></a><h3><p><code><a href="#close"><span class="identifier">close</span></a> ():<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><p class="availability"><em>Available on Neko, Android, iOS, macOS, Linux, Windows</em></p><div class="doc"><p>Close the input source.</p>
<p>Behaviour while reading after calling this method is unspecified.</p></div></div><div class="field "><a name="readAll"></a><h3><p><code><a href="#readAll"><span class="identifier">readAll</span></a> (<span style="white-space:nowrap">?bufsize:<a class="type" title="The standard Int type." href="../../Int.html">Int</a></span>):<a class="type" title="" href="../../haxe/io/Bytes.html">Bytes</a></code></p></h3><p class="availability"><em>Available on Neko, macOS, Linux, Windows</em></p><div class="doc"><p>Read and return all available data.</p>
<p>The <code>bufsize</code> optional argument specifies the size of chunks by
which data is read. Its default value is target-specific.</p></div></div><div class="field "><a name="readByte"></a><h3><p><code><a href="#readByte"><span class="identifier">readByte</span></a> ():<a class="type" title="The standard Int type." href="../../Int.html">Int</a></code></p></h3><p class="availability"><em>Available on Neko, Android, iOS, macOS, Linux, Windows</em></p><div class="doc"><p>Read and return one byte.</p></div></div><div class="field "><a name="readBytes"></a><h3><p><code><a href="#readBytes"><span class="identifier">readBytes</span></a> (<span style="white-space:nowrap">s:<a class="type" title="" href="../../haxe/io/Bytes.html">Bytes</a>,</span> <span style="white-space:nowrap">pos:<a class="type" title="The standard Int type." href="../../Int.html">Int</a>,</span> <span style="white-space:nowrap">len:<a class="type" title="The standard Int type." href="../../Int.html">Int</a></span>):<a class="type" title="The standard Int type." href="../../Int.html">Int</a></code></p></h3><p class="availability"><em>Available on Neko, macOS, Linux, Windows</em></p><div class="doc"><p>Read <code>len</code> bytes and write them into <code>s</code> to the position specified by <code>pos</code>.</p>
<p>Returns the actual length of read data that can be smaller than <code>len</code>.</p>
<p>See <code>readFullBytes</code> that tries to read the exact amount of specified bytes.</p></div></div><div class="field "><a name="readLine"></a><h3><p><code><a href="#readLine"><span class="identifier">readLine</span></a> ():<a class="type" title="The basic String class." href="../../String.html">String</a></code></p></h3><p class="availability"><em>Available on Neko, Android, iOS, macOS, Linux, Windows</em></p><div class="doc"><p>Read a line of text separated by CR and/or LF bytes.</p>
<p>The CR/LF characters are not included in the resulting string.</p></div></div></div></div></div></div></div><footer class="section site-footer" style="background:#FAFAFA"><div class="container"><div class="copyright"><p style="color:#777777">&copy; 2017 &nbsp;<a style="color:#777777" href="http://www.openfl.org">http://www.openfl.org</a></p></div></div></footer><script src="../..//highlighter.js"></script><link href="../../highlighter.css" rel="stylesheet"/></body></html>