aboutsummaryrefslogtreecommitdiff
path: root/irsc/client/struct.SharedClient.html
blob: c060b90961f8a46b35324324ab1ac65091799c91 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
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'>&#x2212;</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>(&amp;self) -&gt; <a class='struct' href='../../carboxyl/stream/struct.Stream.html' title='carboxyl::stream::Stream'>Stream</a>&lt;<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>&gt;</code></h4>
<h4 id='method.events' class='method'><code>fn <a href='#method.events' class='fnname'>events</a>(&amp;self) -&gt; <a class='struct' href='../../carboxyl/stream/struct.Stream.html' title='carboxyl::stream::Stream'>Stream</a>&lt;<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>&lt;'static&gt;)</a>&gt;</code></h4>
<h4 id='method.listen_with_events' class='method'><code>fn <a href='#method.listen_with_events' class='fnname'>listen_with_events</a>(&amp;mut self) -&gt; <a class='struct' href='../../irsc/struct.Result.html' title='irsc::Result'>Result</a>&lt;<a href='http://doc.rust-lang.org/nightly/std/primitive.tuple.html'>()</a>&gt;</code></h4>
<h4 id='method.commands' class='method'><code>fn <a href='#method.commands' class='fnname'>commands</a>(&amp;self) -&gt; <a class='struct' href='../../carboxyl/stream/struct.Stream.html' title='carboxyl::stream::Stream'>Stream</a>&lt;<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>&lt;'static&gt;)</a>&gt;</code></h4>
<h4 id='method.replies' class='method'><code>fn <a href='#method.replies' class='fnname'>replies</a>(&amp;self) -&gt; <a class='struct' href='../../carboxyl/stream/struct.Stream.html' title='carboxyl::stream::Stream'>Stream</a>&lt;<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>&lt;'static&gt;)</a>&gt;</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>(&amp;mut self, msg: <a class='struct' href='../../irsc/message/struct.Message.html' title='irsc::message::Message'>Message</a>) -&gt; <a class='struct' href='../../irsc/struct.Result.html' title='irsc::Result'>Result</a>&lt;<a href='http://doc.rust-lang.org/nightly/std/primitive.tuple.html'>()</a>&gt;</code></h4>
<h4 id='method.join' class='method'><code>fn <a href='../../irsc/client/trait.Client.html#method.join' class='fnname'>join</a>(&amp;mut self, channel: &amp;<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>&lt;&amp;<a href='http://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>&gt;) -&gt; <a class='struct' href='../../irsc/struct.Result.html' title='irsc::Result'>Result</a>&lt;<a href='http://doc.rust-lang.org/nightly/std/primitive.tuple.html'>()</a>&gt;</code></h4>
<h4 id='method.msg' class='method'><code>fn <a href='../../irsc/client/trait.Client.html#method.msg' class='fnname'>msg</a>(&amp;mut self, to: &amp;<a href='http://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>, message: &amp;<a href='http://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>) -&gt; <a class='struct' href='../../irsc/struct.Result.html' title='irsc::Result'>Result</a>&lt;<a href='http://doc.rust-lang.org/nightly/std/primitive.tuple.html'>()</a>&gt;</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>(&amp;mut self, to: &amp;<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'>&amp;[</a>&amp;<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>) -&gt; <a class='struct' href='../../irsc/struct.Result.html' title='irsc::Result'>Result</a>&lt;<a href='http://doc.rust-lang.org/nightly/std/primitive.tuple.html'>()</a>&gt;</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>(&amp;mut self, to: &amp;<a href='http://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>, message: &amp;<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>) -&gt; <a class='struct' href='../../irsc/struct.Result.html' title='irsc::Result'>Result</a>&lt;<a href='http://doc.rust-lang.org/nightly/std/primitive.tuple.html'>()</a>&gt;</code></h4>
<h4 id='method.register' class='method'><code>fn <a href='../../irsc/client/trait.Client.html#method.register' class='fnname'>register</a>(&amp;mut self, nick: &amp;<a href='http://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>, user: &amp;<a href='http://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>, desc: &amp;<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>&lt;&amp;<a href='http://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>&gt;) -&gt; <a class='struct' href='../../irsc/struct.Result.html' title='irsc::Result'>Result</a>&lt;<a href='http://doc.rust-lang.org/nightly/std/primitive.tuple.html'>()</a>&gt;</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>(&amp;self) -&gt; <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>(&amp;mut self, source: &amp;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>&larrb;</dt>
                <dd>Move up in search results</dd>
                <dt>&rarrb;</dt>
                <dd>Move down in search results</dd>
                <dt>&#9166;</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>