mirror of
https://github.com/wren-lang/wren.git
synced 2026-01-12 14:48:40 +01:00
116 lines
4.6 KiB
HTML
116 lines
4.6 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-type" content="text/html;charset=UTF-8" />
|
|
<title>Stdin Class – Wren</title>
|
|
<script type="application/javascript" src="../../../prism.js" data-manual></script>
|
|
<script type="application/javascript" src="../../../wren.js"></script>
|
|
<link rel="stylesheet" type="text/css" href="../../../prism.css" />
|
|
<link rel="stylesheet" type="text/css" href="../../../style.css" />
|
|
<link href='//fonts.googleapis.com/css?family=Source+Sans+Pro:400,700,400italic,700italic|Source+Code+Pro:400|Lato:400|Sanchez:400italic,400' rel='stylesheet' type='text/css'>
|
|
<!-- Tell mobile browsers we're optimized for them and they don't need to crop
|
|
the viewport. -->
|
|
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1"/>
|
|
</head>
|
|
<body id="top" class="module">
|
|
<header>
|
|
<div class="page">
|
|
<div class="main-column">
|
|
<h1><a href="../../../">wren</a></h1>
|
|
<h2>a classy little scripting language</h2>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="page">
|
|
<nav class="big">
|
|
<a href="../../../"><img src="../../../wren.svg" class="logo"></a>
|
|
<ul>
|
|
<li><a href="../../">Back to Wren CLI</a></li>
|
|
<li><a href="../">Back to CLI Modules</a></li>
|
|
<li><a href="./">io module</a></li>
|
|
</ul>
|
|
<section>
|
|
<h2>io classes</h2>
|
|
<ul>
|
|
<li><a href="directory.html">Directory</a></li>
|
|
<li><a href="file.html">File</a></li>
|
|
<li><a href="file-flags.html">FileFlags</a></li>
|
|
<li><a href="stat.html">Stat</a></li>
|
|
<li><a href="stdin.html">Stdin</a></li>
|
|
<li><a href="stdout.html">Stdout</a></li>
|
|
</ul>
|
|
</section>
|
|
</nav>
|
|
<nav class="small">
|
|
<table>
|
|
<tr>
|
|
<td><a href="../">Back to CLI Modules</a></td>
|
|
<td><a href="./">io module</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2"><h2>io classes</h2></td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<ul>
|
|
<li><a href="directory.html">Directory</a></li>
|
|
<li><a href="file.html">File</a></li>
|
|
<li><a href="file-flags.html">FileFlags</a></li>
|
|
</ul>
|
|
</td>
|
|
<td>
|
|
<ul>
|
|
<li><a href="stat.html">Stat</a></li>
|
|
<li><a href="stdin.html">Stdin</a></li>
|
|
<li><a href="stdout.html">Stdout</a></li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</nav>
|
|
<main>
|
|
<h1>Stdin Class</h1>
|
|
<p>The standard input stream.</p>
|
|
<h2>Static Methods <a href="#static-methods" name="static-methods" class="header-anchor">#</a></h2>
|
|
<h3><strong>isRaw</strong> <a href="#israw" name="israw" class="header-anchor">#</a></h3>
|
|
<p>Returns <code>true</code> if stdin is in raw mode. When in raw mode, input is not echoed
|
|
or buffered, and all characters, even non-printing and control characters go
|
|
into stdin.</p>
|
|
<p>Defaults to <code>false</code>.</p>
|
|
<h3><strong>isRaw</strong>=(value) <a href="#israw=(value)" name="israw=(value)" class="header-anchor">#</a></h3>
|
|
<p>Sets raw mode on or off.</p>
|
|
<h3><strong>isTerminal</strong> <a href="#isterminal" name="isterminal" class="header-anchor">#</a></h3>
|
|
<p>Returns <code>true</code> if Stdin is connected to a “TTY”. This is true when the user is
|
|
running Wren in an interactive terminal, and false if it its input is coming
|
|
from a pipe.</p>
|
|
<h3><strong>readByte</strong>() <a href="#readbyte()" name="readbyte()" class="header-anchor">#</a></h3>
|
|
<p>Reads one byte of input from stdin. Blocks the current fiber until a byte has
|
|
been received.</p>
|
|
<p>Returns the byte value as a number or <code>null</code> if stdin is closed.</p>
|
|
<p>Note that output is not automatically flushed when calling this. If you want to
|
|
display a prompt before reading input, you’ll want to call <code>Stdout.flush()</code>
|
|
after printing the prompt.</p>
|
|
<h3><strong>readLine</strong>() <a href="#readline()" name="readline()" class="header-anchor">#</a></h3>
|
|
<p>Reads one line of input from stdin. Blocks the current fiber until a full line
|
|
of input has been received.</p>
|
|
<p>Returns the string of input or <code>null</code> if stdin is closed.</p>
|
|
<p>Note that output is not automatically flushed when calling this. If you want to
|
|
display a prompt before reading input, you’ll want to call <code>Stdout.flush()</code>
|
|
after printing the prompt.</p>
|
|
</main>
|
|
</div>
|
|
<footer>
|
|
<div class="page">
|
|
<div class="main-column">
|
|
<p>Wren lives
|
|
<a href="https://github.com/wren-lang/wren">on GitHub</a>
|
|
— Made with ❤ by
|
|
<a href="http://journal.stuffwithstuff.com/">Bob Nystrom</a> and
|
|
<a href="https://github.com/wren-lang/wren/blob/main/AUTHORS">friends</a>.
|
|
</p>
|
|
<div class="main-column">
|
|
</div>
|
|
</footer>
|
|
</body>
|
|
</html>
|