diff options
Diffstat (limited to 'irsc/client/struct.SharedClient.html')
| -rw-r--r-- | irsc/client/struct.SharedClient.html | 116 |
1 files changed, 116 insertions, 0 deletions
diff --git a/irsc/client/struct.SharedClient.html b/irsc/client/struct.SharedClient.html new file mode 100644 index 0000000..c060b90 --- /dev/null +++ b/irsc/client/struct.SharedClient.html @@ -0,0 +1,116 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="generator" content="rustdoc"> + <meta name="description" content="API documentation for the Rust `SharedClient` struct in crate `irsc`."> + <meta name="keywords" content="rust, rustlang, rust-lang, SharedClient"> + + <title>irsc::client::SharedClient - Rust</title> + + <link rel="stylesheet" type="text/css" href="../../main.css"> + + + +</head> +<body class="rustdoc"> + <!--[if lte IE 8]> + <div class="warning"> + This old browser is unsupported and will most likely display funky + things. + </div> + <![endif]--> + + + + <section class="sidebar"> + + <p class='location'><a href='../index.html'>irsc</a>::<wbr><a href='index.html'>client</a></p><script>window.sidebarCurrent = {name: 'SharedClient', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script> + </section> + + <nav class="sub"> + <form class="search-form js-only"> + <div class="search-container"> + <input class="search-input" name="search" + autocomplete="off" + placeholder="Click or press 'S' to search, '?' for more options..." + type="search"> + </div> + </form> + </nav> + + <section id='main' class="content struct"> +<h1 class='fqn'><span class='in-band'>Struct <a href='../index.html'>irsc</a>::<wbr><a href='index.html'>client</a>::<wbr><a class='struct' href=''>SharedClient</a></span><span class='out-of-band'><span id='render-detail'> + <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs"> + [<span class='inner'>−</span>] + </a> + </span><a id='src-1429' class='srclink' href='../../src/irsc/client.rs.html#236-238' title='goto source code'>[src]</a></span></h1> +<pre class='rust struct'>pub struct SharedClient { + // some fields omitted +}</pre><h2 id='methods'>Methods</h2><h3 class='impl'><code>impl <a class='struct' href='../../irsc/client/struct.SharedClient.html' title='irsc::client::SharedClient'>SharedClient</a></code></h3><div class='impl-items'><h4 id='method.messages' class='method'><code>fn <a href='#method.messages' class='fnname'>messages</a>(&self) -> <a class='struct' href='../../carboxyl/stream/struct.Stream.html' title='carboxyl::stream::Stream'>Stream</a><<a href='http://doc.rust-lang.org/nightly/std/primitive.tuple.html'>(<a class='struct' href='../../irsc/client/struct.SharedClient.html' title='irsc::client::SharedClient'>SharedClient</a>, <a class='struct' href='../../irsc/message/struct.Message.html' title='irsc::message::Message'>Message</a>)</a>></code></h4> +<h4 id='method.events' class='method'><code>fn <a href='#method.events' class='fnname'>events</a>(&self) -> <a class='struct' href='../../carboxyl/stream/struct.Stream.html' title='carboxyl::stream::Stream'>Stream</a><<a href='http://doc.rust-lang.org/nightly/std/primitive.tuple.html'>(<a class='struct' href='../../irsc/client/struct.SharedClient.html' title='irsc::client::SharedClient'>SharedClient</a>, <a class='struct' href='../../irsc/message/struct.Message.html' title='irsc::message::Message'>Message</a>, <a class='enum' href='../../irsc/event/enum.Event.html' title='irsc::event::Event'>Event</a><'static>)</a>></code></h4> +<h4 id='method.listen_with_events' class='method'><code>fn <a href='#method.listen_with_events' class='fnname'>listen_with_events</a>(&mut self) -> <a class='struct' href='../../irsc/struct.Result.html' title='irsc::Result'>Result</a><<a href='http://doc.rust-lang.org/nightly/std/primitive.tuple.html'>()</a>></code></h4> +<h4 id='method.commands' class='method'><code>fn <a href='#method.commands' class='fnname'>commands</a>(&self) -> <a class='struct' href='../../carboxyl/stream/struct.Stream.html' title='carboxyl::stream::Stream'>Stream</a><<a href='http://doc.rust-lang.org/nightly/std/primitive.tuple.html'>(<a class='struct' href='../../irsc/client/struct.SharedClient.html' title='irsc::client::SharedClient'>SharedClient</a>, <a class='struct' href='../../irsc/message/struct.Message.html' title='irsc::message::Message'>Message</a>, <a class='enum' href='../../irsc/command/enum.Command.html' title='irsc::command::Command'>Command</a><'static>)</a>></code></h4> +<h4 id='method.replies' class='method'><code>fn <a href='#method.replies' class='fnname'>replies</a>(&self) -> <a class='struct' href='../../carboxyl/stream/struct.Stream.html' title='carboxyl::stream::Stream'>Stream</a><<a href='http://doc.rust-lang.org/nightly/std/primitive.tuple.html'>(<a class='struct' href='../../irsc/client/struct.SharedClient.html' title='irsc::client::SharedClient'>SharedClient</a>, <a class='struct' href='../../irsc/message/struct.Message.html' title='irsc::message::Message'>Message</a>, <a class='enum' href='../../irsc/reply/enum.Reply.html' title='irsc::reply::Reply'>Reply</a><'static>)</a>></code></h4> +</div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><code>impl <a class='trait' href='../../irsc/client/trait.Client.html' title='irsc::client::Client'>Client</a> for <a class='struct' href='../../irsc/client/struct.SharedClient.html' title='irsc::client::SharedClient'>SharedClient</a></code></h3><div class='impl-items'><h4 id='method.send_message' class='method'><code>fn <a href='../../irsc/client/trait.Client.html#method.send_message' class='fnname'>send_message</a>(&mut self, msg: <a class='struct' href='../../irsc/message/struct.Message.html' title='irsc::message::Message'>Message</a>) -> <a class='struct' href='../../irsc/struct.Result.html' title='irsc::Result'>Result</a><<a href='http://doc.rust-lang.org/nightly/std/primitive.tuple.html'>()</a>></code></h4> +<h4 id='method.join' class='method'><code>fn <a href='../../irsc/client/trait.Client.html#method.join' class='fnname'>join</a>(&mut self, channel: &<a href='http://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>, password: <a class='enum' href='http://doc.rust-lang.org/nightly/core/option/enum.Option.html' title='core::option::Option'>Option</a><&<a href='http://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>>) -> <a class='struct' href='../../irsc/struct.Result.html' title='irsc::Result'>Result</a><<a href='http://doc.rust-lang.org/nightly/std/primitive.tuple.html'>()</a>></code></h4> +<h4 id='method.msg' class='method'><code>fn <a href='../../irsc/client/trait.Client.html#method.msg' class='fnname'>msg</a>(&mut self, to: &<a href='http://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>, message: &<a href='http://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>) -> <a class='struct' href='../../irsc/struct.Result.html' title='irsc::Result'>Result</a><<a href='http://doc.rust-lang.org/nightly/std/primitive.tuple.html'>()</a>></code></h4> +<h4 id='method.msg_many' class='method'><code>fn <a href='../../irsc/client/trait.Client.html#method.msg_many' class='fnname'>msg_many</a>(&mut self, to: &<a href='http://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>, message: <a href='http://doc.rust-lang.org/nightly/std/primitive.slice.html'>&[</a>&<a href='http://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a><a href='http://doc.rust-lang.org/nightly/std/primitive.slice.html'>]</a>) -> <a class='struct' href='../../irsc/struct.Result.html' title='irsc::Result'>Result</a><<a href='http://doc.rust-lang.org/nightly/std/primitive.tuple.html'>()</a>></code></h4> +<h4 id='method.msg_word_wrap' class='method'><code>fn <a href='../../irsc/client/trait.Client.html#method.msg_word_wrap' class='fnname'>msg_word_wrap</a>(&mut self, to: &<a href='http://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>, message: &<a href='http://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>, limit: <a href='http://doc.rust-lang.org/nightly/std/primitive.u16.html'>u16</a>) -> <a class='struct' href='../../irsc/struct.Result.html' title='irsc::Result'>Result</a><<a href='http://doc.rust-lang.org/nightly/std/primitive.tuple.html'>()</a>></code></h4> +<h4 id='method.register' class='method'><code>fn <a href='../../irsc/client/trait.Client.html#method.register' class='fnname'>register</a>(&mut self, nick: &<a href='http://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>, user: &<a href='http://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>, desc: &<a href='http://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>, pass: <a class='enum' href='http://doc.rust-lang.org/nightly/core/option/enum.Option.html' title='core::option::Option'>Option</a><&<a href='http://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>>) -> <a class='struct' href='../../irsc/struct.Result.html' title='irsc::Result'>Result</a><<a href='http://doc.rust-lang.org/nightly/std/primitive.tuple.html'>()</a>></code></h4> +</div><h3 id='derived_implementations'>Derived Implementations </h3><h3 class='impl'><code>impl <a class='trait' href='http://doc.rust-lang.org/nightly/core/clone/trait.Clone.html' title='core::clone::Clone'>Clone</a> for <a class='struct' href='../../irsc/client/struct.SharedClient.html' title='irsc::client::SharedClient'>SharedClient</a></code></h3><div class='impl-items'><h4 id='method.clone' class='method'><code>fn <a href='http://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone' class='fnname'>clone</a>(&self) -> <a class='struct' href='../../irsc/client/struct.SharedClient.html' title='irsc::client::SharedClient'>SharedClient</a></code></h4> +<h4 id='method.clone_from' class='method'><code>fn <a href='http://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: &Self)</code></h4> +</div></section> + <section id='search' class="content hidden"></section> + + <section class="footer"></section> + + <div id="help" class="hidden"> + <div class="shortcuts"> + <h1>Keyboard shortcuts</h1> + <dl> + <dt>?</dt> + <dd>Show this help dialog</dd> + <dt>S</dt> + <dd>Focus the search field</dd> + <dt>⇤</dt> + <dd>Move up in search results</dd> + <dt>⇥</dt> + <dd>Move down in search results</dd> + <dt>⏎</dt> + <dd>Go to active search result</dd> + </dl> + </div> + <div class="infos"> + <h1>Search tricks</h1> + <p> + Prefix searches with a type followed by a colon (e.g. + <code>fn:</code>) to restrict the search to a given type. + </p> + <p> + Accepted types are: <code>fn</code>, <code>mod</code>, + <code>struct</code>, <code>enum</code>, + <code>trait</code>, <code>typedef</code> (or + <code>tdef</code>). + </p> + <p> + Search functions by type signature (e.g. + <code>vec -> usize</code>) + </p> + </div> + </div> + + + + <script> + window.rootPath = "../../"; + window.currentCrate = "irsc"; + window.playgroundUrl = ""; + </script> + <script src="../../jquery.js"></script> + <script src="../../main.js"></script> + + <script async src="../../search-index.js"></script> +</body> +</html>
\ No newline at end of file |