diff options
| author | Jesse Luehrs <doy@tozt.net> | 2013-04-03 20:52:01 -0500 |
|---|---|---|
| committer | Jesse Luehrs <doy@tozt.net> | 2013-04-03 20:52:01 -0500 |
| commit | e7bb35dc9f07d6027b98fe31629d1ceec5893480 (patch) | |
| tree | 8f4231862e41aa7979cf0719a17172a94e88117d | |
| download | rust-term-e7bb35dc9f07d6027b98fe31629d1ceec5893480.tar.gz rust-term-e7bb35dc9f07d6027b98fe31629d1ceec5893480.zip | |
documentation
| -rw-r--r-- | hexes.html | 147 | ||||
| -rw-r--r-- | index.html | 26 | ||||
| -rw-r--r-- | info.html | 300 | ||||
| -rw-r--r-- | ios.html | 57 |
4 files changed, 530 insertions, 0 deletions
diff --git a/hexes.html b/hexes.html new file mode 100644 index 0000000..bd9be72 --- /dev/null +++ b/hexes.html @@ -0,0 +1,147 @@ +<!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/html; charset=utf-8" /> + <meta http-equiv="Content-Style-Type" content="text/css" /> + <meta name="generator" content="pandoc" /> + <title>Module hexes</title> + <style type="text/css">code{white-space: pre;}</style> + <link rel="stylesheet" href="rust.css" type="text/css" /> +</head> +<body> +<div id="header"> +<h1 class="title">Module hexes</h1> +</div> +<div class='index'> + +<ul> +<li><a href="#enum-keypress">Enum <code>Keypress</code></a> - Keys that can be returned by <code>Term::read</code>.</li> +<li><a href="#implementation-for-term">Implementation <code>for Term</code></a></li> +<li><a href="#implementation-of-drop-for-term">Implementation <code>of Drop for Term</code></a></li> +<li><a href="#function-term">Function <code>Term</code></a> - Creates a new <code>Term</code> instance.</li> +</ul> +</div> + +<div class="section level2" id="enum-keypress"> +<h2>Enum <code>Keypress</code></h2> +<p>Keys that can be returned by <code>Term::read</code>.</p> +<div class="section level4" id="variants"> +<h4>Variants</h4> +<ul> +<li><code>KeyCharacter(char)</code></li> +<li><code>KeyBackspace</code></li> +<li><code>KeyReturn</code></li> +<li><code>KeyTab</code></li> +<li><code>KeyCtrl(char)</code></li> +<li><code>KeyF(int)</code></li> +<li><code>KeyUp</code></li> +<li><code>KeyDown</code></li> +<li><code>KeyLeft</code></li> +<li><code>KeyRight</code></li> +<li><code>KeyHome</code></li> +<li><code>KeyEnd</code></li> +<li><code>KeyInsert</code></li> +<li><code>KeyDelete</code></li> +<li><code>KeyEscape</code></li> +</ul> +</div> +</div> +<div class="section level2" id="implementation-for-term"> +<h2>Implementation for <code>Term</code></h2> +<div class="section level3" id="method-clear"> +<h3>Method <code>clear</code></h3> +<pre><code>fn clear(&mut self)</code></pre> +<p>Clears the screen.</p> +</div> +<div class="section level3" id="method-move"> +<h3>Method <code>move</code></h3> +<pre><code>fn move(&mut self, col: uint, row: uint)</code></pre> +<p>Moves the cursor to (<code>col</code>, <code>row</code>).</p> +</div> +<div class="section level3" id="method-fg_color"> +<h3>Method <code>fg_color</code></h3> +<pre><code>fn fg_color(&mut self, color: info::Color)</code></pre> +<p>Changes the currently active foreground color to <code>color</code>.</p> +</div> +<div class="section level3" id="method-bg_color"> +<h3>Method <code>bg_color</code></h3> +<pre><code>fn bg_color(&mut self, color: info::Color)</code></pre> +<p>Changes the currently active background color to <code>color</code>.</p> +</div> +<div class="section level3" id="method-reset_color"> +<h3>Method <code>reset_color</code></h3> +<pre><code>fn reset_color(&mut self)</code></pre> +<p>Resets the foreground and background colors to the default.</p> +</div> +<div class="section level3" id="method-underline"> +<h3>Method <code>underline</code></h3> +<pre><code>fn underline(&mut self, enabled: bool)</code></pre> +<p>Enables or disables underline mode.</p> +</div> +<div class="section level3" id="method-standout"> +<h3>Method <code>standout</code></h3> +<pre><code>fn standout(&mut self, enabled: bool)</code></pre> +<p>Enables or disables standout mode.</p> +</div> +<div class="section level3" id="method-reverse"> +<h3>Method <code>reverse</code></h3> +<pre><code>fn reverse(&mut self, enabled: bool)</code></pre> +<p>Enables or disables reverse mode.</p> +</div> +<div class="section level3" id="method-bold"> +<h3>Method <code>bold</code></h3> +<pre><code>fn bold(&mut self, enabled: bool)</code></pre> +<p>Enables or disables bold mode.</p> +</div> +<div class="section level3" id="method-blink"> +<h3>Method <code>blink</code></h3> +<pre><code>fn blink(&mut self, enabled: bool)</code></pre> +<p>Enables or disables blink mode.</p> +</div> +<div class="section level3" id="method-cursor"> +<h3>Method <code>cursor</code></h3> +<pre><code>fn cursor(&mut self, enabled: bool)</code></pre> +<p>Enables or disables visible cursor mode.</p> +</div> +<div class="section level3" id="method-alternate_screen"> +<h3>Method <code>alternate_screen</code></h3> +<pre><code>fn alternate_screen(&mut self, enabled: bool)</code></pre> +<p>Switches to or from the alternate screen.</p> +<p>This is used to provide a separate place to do all of the drawing for a full screen app, so that at the end of the application, the terminal will be restored to the original state.</p> +</div> +<div class="section level3" id="method-write"> +<h3>Method <code>write</code></h3> +<pre><code>fn write(&mut self, text: &str)</code></pre> +<p>Write a string to the terminal.</p> +<p>Due to buffering, using <code>io::print()</code> will not work properly. All text written to the terminal must go through the <code>Term</code> object, or the state of the screen will likely end up incorrect.</p> +</div> +<div class="section level3" id="method-flush"> +<h3>Method <code>flush</code></h3> +<pre><code>fn flush(&mut self)</code></pre> +<p>Flush the data written so far to the terminal.</p> +<p>This is also done implicitly before every call to <code>read</code>, so there's not usually a reason to do it manually, other than edge cases such as timed animations.</p> +</div> +<div class="section level3" id="method-read"> +<h3>Method <code>read</code></h3> +<pre><code>fn read(&mut self) -> Option<Keypress></code></pre> +<p>Read a keypress from the terminal.</p> +<p>Returns <code>Some(Keypress)</code> if a key was read, and <code>None</code> if <code>stdin</code> reaches <code>eof</code>.</p> +<p>Note that most special keys are actually sequences of multiple characters. This means that if a prefix of a special character key sequence was read, it has to wait to see if there are more characters coming, or if that character was the only key. Since most of these multi-character sequences start with escape, there will be a delay in reading a single <code>KeyEscape</code> keypress.</p> +<p>Also, other special keys are represented as control keys, so for instance, <code>^J</code> will likely return <code>KeyReturn</code> instead of <code>KeyCtrl('j')</code>.</p> +</div> +</div> +<div class="section level2" id="implementation-of-drop-for-term"> +<h2>Implementation of <code>Drop</code> for <code>Term</code></h2> +<div class="section level3" id="method-finalize"> +<h3>Method <code>finalize</code></h3> +<pre><code>fn finalize(&self)</code></pre> +</div> +</div> +<div class="section level2" id="function-term"> +<h2>Function <code>Term</code></h2> +<pre><code>fn Term() -> Term</code></pre> +<p>Creates a new <code>Term</code> instance.</p> +<p>This can be used to manipulate the terminal for full screen applications.</p> +</div> +</body> +</html> diff --git a/index.html b/index.html new file mode 100644 index 0000000..a728b44 --- /dev/null +++ b/index.html @@ -0,0 +1,26 @@ +<!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/html; charset=utf-8" /> + <meta http-equiv="Content-Style-Type" content="text/css" /> + <meta name="generator" content="pandoc" /> + <title>Crate term</title> + <style type="text/css">code{white-space: pre;}</style> + <link rel="stylesheet" href="rust.css" type="text/css" /> +</head> +<body> +<div id="header"> +<h1 class="title">Crate term</h1> +</div> +<div class='index'> + +<ul> +<li><a href="hexes.html">Module <code>hexes</code></a></li> +<li><a href="info.html">Module <code>info</code></a></li> +<li><a href="ios.html">Module <code>ios</code></a></li> +</ul> +</div> + + +</body> +</html> diff --git a/info.html b/info.html new file mode 100644 index 0000000..64d9f2b --- /dev/null +++ b/info.html @@ -0,0 +1,300 @@ +<!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/html; charset=utf-8" /> + <meta http-equiv="Content-Style-Type" content="text/css" /> + <meta name="generator" content="pandoc" /> + <title>Module info</title> + <style type="text/css">code{white-space: pre;}</style> + <link rel="stylesheet" href="rust.css" type="text/css" /> +</head> +<body> +<div id="header"> +<h1 class="title">Module info</h1> +</div> +<div class='index'> + +<ul> +<li><a href="#enum-color">Enum <code>Color</code></a> - The default colors available on a terminal emulator.</li> +<li><a href="#implementation-of-corecmpeq-for-color">Implementation <code>of ::core::cmp::Eq for Color</code></a></li> +<li><a href="#function-carriage_return">Function <code>carriage_return</code></a></li> +<li><a href="#function-clear_screen">Function <code>clear_screen</code></a></li> +<li><a href="#function-cursor_address">Function <code>cursor_address</code></a></li> +<li><a href="#function-cursor_home">Function <code>cursor_home</code></a></li> +<li><a href="#function-cursor_invisible">Function <code>cursor_invisible</code></a></li> +<li><a href="#function-cursor_normal">Function <code>cursor_normal</code></a></li> +<li><a href="#function-enter_blink_mode">Function <code>enter_blink_mode</code></a></li> +<li><a href="#function-enter_bold_mode">Function <code>enter_bold_mode</code></a></li> +<li><a href="#function-enter_ca_mode">Function <code>enter_ca_mode</code></a></li> +<li><a href="#function-enter_reverse_mode">Function <code>enter_reverse_mode</code></a></li> +<li><a href="#function-enter_standout_mode">Function <code>enter_standout_mode</code></a></li> +<li><a href="#function-enter_underline_mode">Function <code>enter_underline_mode</code></a></li> +<li><a href="#function-escape">Function <code>escape</code></a> - The terminal escape corresponding to the <code>name</code> terminfo capability.</li> +<li><a href="#function-escape1">Function <code>escape1</code></a> - The terminal escape corresponding to the <code>name</code> terminfo capability.</li> +<li><a href="#function-escape2">Function <code>escape2</code></a> - The terminal escape corresponding to the <code>name</code> terminfo capability.</li> +<li><a href="#function-exit_attribute_mode">Function <code>exit_attribute_mode</code></a></li> +<li><a href="#function-exit_ca_mode">Function <code>exit_ca_mode</code></a></li> +<li><a href="#function-exit_standout_mode">Function <code>exit_standout_mode</code></a></li> +<li><a href="#function-exit_underline_mode">Function <code>exit_underline_mode</code></a></li> +<li><a href="#function-init">Function <code>init</code></a> - Initialize the terminfo database.</li> +<li><a href="#function-key_backspace">Function <code>key_backspace</code></a></li> +<li><a href="#function-key_dc">Function <code>key_dc</code></a></li> +<li><a href="#function-key_down">Function <code>key_down</code></a></li> +<li><a href="#function-key_end">Function <code>key_end</code></a></li> +<li><a href="#function-key_f">Function <code>key_f</code></a> - The terminal escape generated by the F<<code>n</code>> key.</li> +<li><a href="#function-key_f1">Function <code>key_f1</code></a></li> +<li><a href="#function-key_f10">Function <code>key_f10</code></a></li> +<li><a href="#function-key_f11">Function <code>key_f11</code></a></li> +<li><a href="#function-key_f12">Function <code>key_f12</code></a></li> +<li><a href="#function-key_f2">Function <code>key_f2</code></a></li> +<li><a href="#function-key_f3">Function <code>key_f3</code></a></li> +<li><a href="#function-key_f4">Function <code>key_f4</code></a></li> +<li><a href="#function-key_f5">Function <code>key_f5</code></a></li> +<li><a href="#function-key_f6">Function <code>key_f6</code></a></li> +<li><a href="#function-key_f7">Function <code>key_f7</code></a></li> +<li><a href="#function-key_f8">Function <code>key_f8</code></a></li> +<li><a href="#function-key_f9">Function <code>key_f9</code></a></li> +<li><a href="#function-key_home">Function <code>key_home</code></a></li> +<li><a href="#function-key_ic">Function <code>key_ic</code></a></li> +<li><a href="#function-key_left">Function <code>key_left</code></a></li> +<li><a href="#function-key_right">Function <code>key_right</code></a></li> +<li><a href="#function-key_up">Function <code>key_up</code></a></li> +<li><a href="#function-keypad_local">Function <code>keypad_local</code></a></li> +<li><a href="#function-keypad_xmit">Function <code>keypad_xmit</code></a></li> +<li><a href="#function-orig_pair">Function <code>orig_pair</code></a></li> +<li><a href="#function-set_a_background">Function <code>set_a_background</code></a></li> +<li><a href="#function-set_a_foreground">Function <code>set_a_foreground</code></a></li> +<li><a href="#function-tab">Function <code>tab</code></a></li> +</ul> +</div> + +<div class="section level2" id="enum-color"> +<h2>Enum <code>Color</code></h2> +<p>The default colors available on a terminal emulator.</p> +<div class="section level4" id="variants"> +<h4>Variants</h4> +<ul> +<li><code>ColorBlack = 0</code></li> +<li><code>ColorRed</code></li> +<li><code>ColorGreen</code></li> +<li><code>ColorYellow</code></li> +<li><code>ColorBlue</code></li> +<li><code>ColorMagenta</code></li> +<li><code>ColorCyan</code></li> +<li><code>ColorWhite</code></li> +</ul> +</div> +</div> +<div class="section level2" id="implementation-of-corecmpeq-for-color"> +<h2>Implementation of <code>::core::cmp::Eq</code> for <code>Color</code></h2> +<div class="section level3" id="method-eq"> +<h3>Method <code>eq</code></h3> +<pre><code>fn eq(&self, __other: &Color) -> bool</code></pre> +</div> +<div class="section level3" id="method-ne"> +<h3>Method <code>ne</code></h3> +<pre><code>fn ne(&self, __other: &Color) -> bool</code></pre> +</div> +</div> +<div class="section level2" id="function-carriage_return"> +<h2>Function <code>carriage_return</code></h2> +<pre><code>fn carriage_return() -> ~str</code></pre> +</div> +<div class="section level2" id="function-clear_screen"> +<h2>Function <code>clear_screen</code></h2> +<pre><code>fn clear_screen() -> ~str</code></pre> +</div> +<div class="section level2" id="function-cursor_address"> +<h2>Function <code>cursor_address</code></h2> +<pre><code>fn cursor_address(p1: uint, p2: uint) -> ~str</code></pre> +</div> +<div class="section level2" id="function-cursor_home"> +<h2>Function <code>cursor_home</code></h2> +<pre><code>fn cursor_home() -> ~str</code></pre> +</div> +<div class="section level2" id="function-cursor_invisible"> +<h2>Function <code>cursor_invisible</code></h2> +<pre><code>fn cursor_invisible() -> ~str</code></pre> +</div> +<div class="section level2" id="function-cursor_normal"> +<h2>Function <code>cursor_normal</code></h2> +<pre><code>fn cursor_normal() -> ~str</code></pre> +</div> +<div class="section level2" id="function-enter_blink_mode"> +<h2>Function <code>enter_blink_mode</code></h2> +<pre><code>fn enter_blink_mode() -> ~str</code></pre> +</div> +<div class="section level2" id="function-enter_bold_mode"> +<h2>Function <code>enter_bold_mode</code></h2> +<pre><code>fn enter_bold_mode() -> ~str</code></pre> +</div> +<div class="section level2" id="function-enter_ca_mode"> +<h2>Function <code>enter_ca_mode</code></h2> +<pre><code>fn enter_ca_mode() -> ~str</code></pre> +</div> +<div class="section level2" id="function-enter_reverse_mode"> +<h2>Function <code>enter_reverse_mode</code></h2> +<pre><code>fn enter_reverse_mode() -> ~str</code></pre> +</div> +<div class="section level2" id="function-enter_standout_mode"> +<h2>Function <code>enter_standout_mode</code></h2> +<pre><code>fn enter_standout_mode() -> ~str</code></pre> +</div> +<div class="section level2" id="function-enter_underline_mode"> +<h2>Function <code>enter_underline_mode</code></h2> +<pre><code>fn enter_underline_mode() -> ~str</code></pre> +</div> +<div class="section level2" id="function-escape"> +<h2>Function <code>escape</code></h2> +<pre><code>fn escape(name: &str) -> ~str</code></pre> +<p>The terminal escape corresponding to the <code>name</code> terminfo capability.</p> +</div> +<div class="section level2" id="function-escape1"> +<h2>Function <code>escape1</code></h2> +<pre><code>fn escape1(name: &str, p1: int) -> ~str</code></pre> +<p>The terminal escape corresponding to the <code>name</code> terminfo capability.</p> +<p>This capability must take one parameter, which should be passed as <code>p1</code>.</p> +</div> +<div class="section level2" id="function-escape2"> +<h2>Function <code>escape2</code></h2> +<pre><code>fn escape2(name: &str, p1: int, p2: int) -> ~str</code></pre> +<p>The terminal escape corresponding to the <code>name</code> terminfo capability.</p> +<p>This capability must take two parameters, which should be passed as <code>p1</code> and <code>p2</code>.</p> +</div> +<div class="section level2" id="function-exit_attribute_mode"> +<h2>Function <code>exit_attribute_mode</code></h2> +<pre><code>fn exit_attribute_mode() -> ~str</code></pre> +</div> +<div class="section level2" id="function-exit_ca_mode"> +<h2>Function <code>exit_ca_mode</code></h2> +<pre><code>fn exit_ca_mode() -> ~str</code></pre> +</div> +<div class="section level2" id="function-exit_standout_mode"> +<h2>Function <code>exit_standout_mode</code></h2> +<pre><code>fn exit_standout_mode() -> ~str</code></pre> +</div> +<div class="section level2" id="function-exit_underline_mode"> +<h2>Function <code>exit_underline_mode</code></h2> +<pre><code>fn exit_underline_mode() -> ~str</code></pre> +</div> +<div class="section level2" id="function-init"> +<h2>Function <code>init</code></h2> +<pre><code>fn init()</code></pre> +<p>Initialize the terminfo database.</p> +<p>This must be called before any functions from this module are used. The current terminal is determined by looking at the <code>TERM</code> environment variable.</p> +</div> +<div class="section level2" id="function-key_backspace"> +<h2>Function <code>key_backspace</code></h2> +<pre><code>fn key_backspace() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_dc"> +<h2>Function <code>key_dc</code></h2> +<pre><code>fn key_dc() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_down"> +<h2>Function <code>key_down</code></h2> +<pre><code>fn key_down() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_end"> +<h2>Function <code>key_end</code></h2> +<pre><code>fn key_end() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_f"> +<h2>Function <code>key_f</code></h2> +<pre><code>fn key_f(n: uint) -> ~str</code></pre> +<p>The terminal escape generated by the F<<code>n</code>> key.</p> +</div> +<div class="section level2" id="function-key_f1"> +<h2>Function <code>key_f1</code></h2> +<pre><code>fn key_f1() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_f10"> +<h2>Function <code>key_f10</code></h2> +<pre><code>fn key_f10() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_f11"> +<h2>Function <code>key_f11</code></h2> +<pre><code>fn key_f11() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_f12"> +<h2>Function <code>key_f12</code></h2> +<pre><code>fn key_f12() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_f2"> +<h2>Function <code>key_f2</code></h2> +<pre><code>fn key_f2() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_f3"> +<h2>Function <code>key_f3</code></h2> +<pre><code>fn key_f3() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_f4"> +<h2>Function <code>key_f4</code></h2> +<pre><code>fn key_f4() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_f5"> +<h2>Function <code>key_f5</code></h2> +<pre><code>fn key_f5() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_f6"> +<h2>Function <code>key_f6</code></h2> +<pre><code>fn key_f6() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_f7"> +<h2>Function <code>key_f7</code></h2> +<pre><code>fn key_f7() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_f8"> +<h2>Function <code>key_f8</code></h2> +<pre><code>fn key_f8() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_f9"> +<h2>Function <code>key_f9</code></h2> +<pre><code>fn key_f9() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_home"> +<h2>Function <code>key_home</code></h2> +<pre><code>fn key_home() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_ic"> +<h2>Function <code>key_ic</code></h2> +<pre><code>fn key_ic() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_left"> +<h2>Function <code>key_left</code></h2> +<pre><code>fn key_left() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_right"> +<h2>Function <code>key_right</code></h2> +<pre><code>fn key_right() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_up"> +<h2>Function <code>key_up</code></h2> +<pre><code>fn key_up() -> ~str</code></pre> +</div> +<div class="section level2" id="function-keypad_local"> +<h2>Function <code>keypad_local</code></h2> +<pre><code>fn keypad_local() -> ~str</code></pre> +</div> +<div class="section level2" id="function-keypad_xmit"> +<h2>Function <code>keypad_xmit</code></h2> +<pre><code>fn keypad_xmit() -> ~str</code></pre> +</div> +<div class="section level2" id="function-orig_pair"> +<h2>Function <code>orig_pair</code></h2> +<pre><code>fn orig_pair() -> ~str</code></pre> +</div> +<div class="section level2" id="function-set_a_background"> +<h2>Function <code>set_a_background</code></h2> +<pre><code>fn set_a_background(p1: Color) -> ~str</code></pre> +</div> +<div class="section level2" id="function-set_a_foreground"> +<h2>Function <code>set_a_foreground</code></h2> +<pre><code>fn set_a_foreground(p1: Color) -> ~str</code></pre> +</div> +<div class="section level2" id="function-tab"> +<h2>Function <code>tab</code></h2> +<pre><code>fn tab() -> ~str</code></pre> +</div> +</body> +</html> diff --git a/ios.html b/ios.html new file mode 100644 index 0000000..660e89f --- /dev/null +++ b/ios.html @@ -0,0 +1,57 @@ +<!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/html; charset=utf-8" /> + <meta http-equiv="Content-Style-Type" content="text/css" /> + <meta name="generator" content="pandoc" /> + <title>Module ios</title> + <style type="text/css">code{white-space: pre;}</style> + <link rel="stylesheet" href="rust.css" type="text/css" /> +</head> +<body> +<div id="header"> +<h1 class="title">Module ios</h1> +</div> +<div class='index'> + +<ul> +<li><a href="#function-cbreak">Function <code>cbreak</code></a> - Put the terminal into cbreak mode.</li> +<li><a href="#function-cooked">Function <code>cooked</code></a> - Put the terminal into cooked mode.</li> +<li><a href="#function-echo">Function <code>echo</code></a> - Change the echo mode of the terminal.</li> +<li><a href="#function-preserve">Function <code>preserve</code></a> - Run a block of code, restoring the terminal state when the block ends.</li> +<li><a href="#function-raw">Function <code>raw</code></a> - Put the terminal into raw mode.</li> +</ul> +</div> + +<div class="section level2" id="function-cbreak"> +<h2>Function <code>cbreak</code></h2> +<pre><code>fn cbreak() -> int</code></pre> +<p>Put the terminal into cbreak mode.</p> +<p>This is the normal unbuffered mode.</p> +</div> +<div class="section level2" id="function-cooked"> +<h2>Function <code>cooked</code></h2> +<pre><code>fn cooked() -> int</code></pre> +<p>Put the terminal into cooked mode.</p> +<p>This is the normal line-buffered mode.</p> +</div> +<div class="section level2" id="function-echo"> +<h2>Function <code>echo</code></h2> +<pre><code>fn echo(enable: bool) -> int</code></pre> +<p>Change the echo mode of the terminal.</p> +<p><code>true</code> turns echo on, and <code>false</code> turns echo off.</p> +</div> +<div class="section level2" id="function-preserve"> +<h2>Function <code>preserve</code></h2> +<pre><code>fn preserve<T>(body: &fn() -> T) -> T</code></pre> +<p>Run a block of code, restoring the terminal state when the block ends.</p> +<p>This will ensure you don't leave the terminal in a broken state, even if the current task fails.</p> +</div> +<div class="section level2" id="function-raw"> +<h2>Function <code>raw</code></h2> +<pre><code>fn raw() -> int</code></pre> +<p>Put the terminal into raw mode.</p> +<p>This is like cbreak mode, except that control characters (like ^C) are not translated into signals.</p> +</div> +</body> +</html> |