1
0
mirror of https://github.com/actix/actix-extras.git synced 2025-08-30 11:08:08 +02:00

Deploying to gh-pages from @ 0b2eff9384 🚀

This commit is contained in:
robjtede
2020-11-05 18:41:15 +00:00
parent 2f02215391
commit 5651a21a5c
8 changed files with 39 additions and 25 deletions

View File

@@ -14,7 +14,7 @@
</div></div><h3 id='impl-StreamHandler%3CResult%3CRespValue%2C%20Error%3E%3E' class='impl'><code class='in-band'>impl StreamHandler&lt;<a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="enum" href="../actix_redis/enum.RespValue.html" title="enum actix_redis::RespValue">RespValue</a>, <a class="enum" href="../actix_redis/enum.RespError.html" title="enum actix_redis::RespError">Error</a>&gt;&gt; for <a class="struct" href="../actix_redis/struct.RedisActor.html" title="struct actix_redis::RedisActor">RedisActor</a></code><a href='#impl-StreamHandler%3CResult%3CRespValue%2C%20Error%3E%3E' class='anchor'></a><a class='srclink' href='../src/actix_redis/redis.rs.html#113-129' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.handle-1' class="method hidden"><code>fn <a href='#method.handle' class='fnname'>handle</a>(&amp;mut self, msg: <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="enum" href="../actix_redis/enum.RespValue.html" title="enum actix_redis::RespValue">RespValue</a>, <a class="enum" href="../actix_redis/enum.RespError.html" title="enum actix_redis::RespError">RespError</a>&gt;, ctx: &amp;mut Self::Context)</code><a class='srclink' href='../src/actix_redis/redis.rs.html#114-128' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Method is called for every message received by this Actor</p>
</div><h4 id='method.started-1' class="method hidden"><code>fn <a href='#method.started' class='fnname'>started</a>(&amp;mut self, ctx: &amp;mut Self::Context)</code></h4><div class='docblock hidden'><p>Method is called when stream get polled first time.</p>
</div><h4 id='method.finished' class="method hidden"><code>fn <a href='#method.finished' class='fnname'>finished</a>(&amp;mut self, ctx: &amp;mut Self::Context)</code></h4><div class='docblock hidden'><p>Method is called when stream finishes. <a href="#method.finished">Read more</a></p>
</div><h4 id='method.add_stream' class="method hidden"><code>fn <a href='#method.add_stream' class='fnname'>add_stream</a>&lt;S&gt;(fut: S, ctx: &amp;mut Self::Context) -&gt; SpawnHandle <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;I: 'static,<br>&nbsp;&nbsp;&nbsp;&nbsp;S: <a class="trait" href="https://docs.rs/futures-core/0.3.6/futures_core/stream/trait.Stream.html" title="trait futures_core::stream::Stream">Stream</a>&lt;Item = I&gt; + 'static,<br>&nbsp;&nbsp;&nbsp;&nbsp;Self::Context: AsyncContext&lt;Self&gt;,&nbsp;</span></code></h4><div class='docblock hidden'><p>This method register stream to an actor context and allows to handle <code>Stream</code> in similar way as normal actor messages. <a href="#method.add_stream">Read more</a></p>
</div><h4 id='method.add_stream' class="method hidden"><code>fn <a href='#method.add_stream' class='fnname'>add_stream</a>&lt;S&gt;(fut: S, ctx: &amp;mut Self::Context) -&gt; SpawnHandle <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;I: 'static,<br>&nbsp;&nbsp;&nbsp;&nbsp;S: <a class="trait" href="https://docs.rs/futures-core/0.3.7/futures_core/stream/trait.Stream.html" title="trait futures_core::stream::Stream">Stream</a>&lt;Item = I&gt; + 'static,<br>&nbsp;&nbsp;&nbsp;&nbsp;Self::Context: AsyncContext&lt;Self&gt;,&nbsp;</span></code></h4><div class='docblock hidden'><p>This method register stream to an actor context and allows to handle <code>Stream</code> in similar way as normal actor messages. <a href="#method.add_stream">Read more</a></p>
</div></div><h3 id='impl-Supervised' class='impl'><code class='in-band'>impl Supervised for <a class="struct" href="../actix_redis/struct.RedisActor.html" title="struct actix_redis::RedisActor">RedisActor</a></code><a href='#impl-Supervised' class='anchor'></a><a class='srclink' href='../src/actix_redis/redis.rs.html#97-104' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.restarting' class="method hidden"><code>fn <a href='#method.restarting' class='fnname'>restarting</a>(&amp;mut self, _: &amp;mut Self::Context)</code><a class='srclink' href='../src/actix_redis/redis.rs.html#98-103' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Called when the supervisor restarts a failed actor.</p>
</div></div><h3 id='impl-WriteHandler%3CError%3E' class='impl'><code class='in-band'>impl WriteHandler&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>&gt; for <a class="struct" href="../actix_redis/struct.RedisActor.html" title="struct actix_redis::RedisActor">RedisActor</a></code><a href='#impl-WriteHandler%3CError%3E' class='anchor'></a><a class='srclink' href='../src/actix_redis/redis.rs.html#106-111' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.error' class="method hidden"><code>fn <a href='#method.error' class='fnname'>error</a>(&amp;mut self, err: <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>, _: &amp;mut Self::Context) -&gt; Running</code><a class='srclink' href='../src/actix_redis/redis.rs.html#107-110' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Called when the writer emits error. <a href="#method.error">Read more</a></p>
</div><h4 id='method.finished-1' class="method hidden"><code>fn <a href='#method.finished' class='fnname'>finished</a>(&amp;mut self, ctx: &amp;mut Self::Context)</code></h4><div class='docblock hidden'><p>Called when the writer finishes. <a href="#method.finished">Read more</a></p>
@@ -22,8 +22,10 @@
</div></div><h3 id='impl-Borrow%3CT%3E' class='impl'><code class='in-band'>impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a>&lt;T&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></code><a href='#impl-Borrow%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#210-214' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow' class="method hidden"><code>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow' class='fnname'>borrow</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#211-213' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
</div></div><h3 id='impl-BorrowMut%3CT%3E' class='impl'><code class='in-band'>impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a>&lt;T&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></code><a href='#impl-BorrowMut%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#217-221' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow_mut' class="method hidden"><code>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut' class='fnname'>borrow_mut</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#218-220' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
</div></div><h3 id='impl-From%3CT%3E' class='impl'><code class='in-band'>impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for T</code><a href='#impl-From%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#570-574' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from' class="method hidden"><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(t: T) -&gt; T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#571-573' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3 id='impl-Instrument' class='impl'><code class='in-band'>impl&lt;T&gt; <a class="trait" href="https://docs.rs/tracing/0.1.21/tracing/instrument/trait.Instrument.html" title="trait tracing::instrument::Instrument">Instrument</a> for T</code><a href='#impl-Instrument' class='anchor'></a><a class='srclink' href='https://docs.rs/tracing/0.1.21/src/tracing/instrument.rs.html#155' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.instrument' class="method hidden"><code>fn <a href='https://docs.rs/tracing/0.1.21/tracing/instrument/trait.Instrument.html#method.instrument' class='fnname'>instrument</a>(self, span: <a class="struct" href="https://docs.rs/tracing/0.1.21/tracing/span/struct.Span.html" title="struct tracing::span::Span">Span</a>) -&gt; <a class="struct" href="https://docs.rs/tracing/0.1.21/tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a>&lt;Self&gt;</code><a class='srclink' href='https://docs.rs/tracing/0.1.21/src/tracing/instrument.rs.html#38-40' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Instruments this type with the provided <code>Span</code>, returning an <code>Instrumented</code> wrapper. <a href="https://docs.rs/tracing/0.1.21/tracing/instrument/trait.Instrument.html#method.instrument">Read more</a></p>
</div><h4 id='method.in_current_span' class="method hidden"><code>fn <a href='https://docs.rs/tracing/0.1.21/tracing/instrument/trait.Instrument.html#method.in_current_span' class='fnname'>in_current_span</a>(self) -&gt; <a class="struct" href="https://docs.rs/tracing/0.1.21/tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a>&lt;Self&gt;</code><a class='srclink' href='https://docs.rs/tracing/0.1.21/src/tracing/instrument.rs.html#74-76' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Instruments this type with the [current] <code>Span</code>, returning an <code>Instrumented</code> wrapper. <a href="https://docs.rs/tracing/0.1.21/tracing/instrument/trait.Instrument.html#method.in_current_span">Read more</a></p>
</div></div><h3 id='impl-Instrument' class='impl'><code class='in-band'>impl&lt;T&gt; <a class="trait" href="https://docs.rs/tracing-futures/0.2.3/tracing_futures/trait.Instrument.html" title="trait tracing_futures::Instrument">Instrument</a> for T</code><a href='#impl-Instrument' class='anchor'></a><a class='srclink' href='https://docs.rs/tracing-futures/0.2.3/src/tracing_futures/lib.rs.html#248' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.instrument' class="method hidden"><code>fn <a href='https://docs.rs/tracing-futures/0.2.3/tracing_futures/trait.Instrument.html#method.instrument' class='fnname'>instrument</a>(self, span: <a class="struct" href="https://docs.rs/tracing/0.1.21/tracing/span/struct.Span.html" title="struct tracing::span::Span">Span</a>) -&gt; <a class="struct" href="https://docs.rs/tracing-futures/0.2.3/tracing_futures/struct.Instrumented.html" title="struct tracing_futures::Instrumented">Instrumented</a>&lt;Self&gt;</code><a class='srclink' href='https://docs.rs/tracing-futures/0.2.3/src/tracing_futures/lib.rs.html#129-131' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Instruments this type with the provided <code>Span</code>, returning an <code>Instrumented</code> wrapper. <a href="https://docs.rs/tracing-futures/0.2.3/tracing_futures/trait.Instrument.html#method.instrument">Read more</a></p>
</div><h4 id='method.in_current_span' class="method hidden"><code>fn <a href='https://docs.rs/tracing-futures/0.2.3/tracing_futures/trait.Instrument.html#method.in_current_span' class='fnname'>in_current_span</a>(self) -&gt; <a class="struct" href="https://docs.rs/tracing-futures/0.2.3/tracing_futures/struct.Instrumented.html" title="struct tracing_futures::Instrumented">Instrumented</a>&lt;Self&gt;</code><a class='srclink' href='https://docs.rs/tracing-futures/0.2.3/src/tracing_futures/lib.rs.html#166-168' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Instruments this type with the [current] <code>Span</code>, returning an <code>Instrumented</code> wrapper. <a href="https://docs.rs/tracing-futures/0.2.3/tracing_futures/trait.Instrument.html#method.in_current_span">Read more</a></p>
</div></div><h3 id='impl-Instrument-1' class='impl'><code class='in-band'>impl&lt;T&gt; <a class="trait" href="https://docs.rs/tracing/0.1.21/tracing/instrument/trait.Instrument.html" title="trait tracing::instrument::Instrument">Instrument</a> for T</code><a href='#impl-Instrument-1' class='anchor'></a><a class='srclink' href='https://docs.rs/tracing/0.1.21/src/tracing/instrument.rs.html#155' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.instrument-1' class="method hidden"><code>fn <a href='https://docs.rs/tracing/0.1.21/tracing/instrument/trait.Instrument.html#method.instrument' class='fnname'>instrument</a>(self, span: <a class="struct" href="https://docs.rs/tracing/0.1.21/tracing/span/struct.Span.html" title="struct tracing::span::Span">Span</a>) -&gt; <a class="struct" href="https://docs.rs/tracing/0.1.21/tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a>&lt;Self&gt;</code><a class='srclink' href='https://docs.rs/tracing/0.1.21/src/tracing/instrument.rs.html#38-40' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Instruments this type with the provided <code>Span</code>, returning an <code>Instrumented</code> wrapper. <a href="https://docs.rs/tracing/0.1.21/tracing/instrument/trait.Instrument.html#method.instrument">Read more</a></p>
</div><h4 id='method.in_current_span-1' class="method hidden"><code>fn <a href='https://docs.rs/tracing/0.1.21/tracing/instrument/trait.Instrument.html#method.in_current_span' class='fnname'>in_current_span</a>(self) -&gt; <a class="struct" href="https://docs.rs/tracing/0.1.21/tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a>&lt;Self&gt;</code><a class='srclink' href='https://docs.rs/tracing/0.1.21/src/tracing/instrument.rs.html#74-76' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Instruments this type with the [current] <code>Span</code>, returning an <code>Instrumented</code> wrapper. <a href="https://docs.rs/tracing/0.1.21/tracing/instrument/trait.Instrument.html#method.in_current_span">Read more</a></p>
</div></div><h3 id='impl-Into%3CU%3E' class='impl'><code class='in-band'>impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;U&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt;,&nbsp;</span></code><a href='#impl-Into%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#559-566' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.into' class="method hidden"><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into' class='fnname'>into</a>(self) -&gt; U</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#563-565' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3 id='impl-Same%3CT%3E' class='impl'><code class='in-band'>impl&lt;T&gt; Same&lt;T&gt; for T</code><a href='#impl-Same%3CT%3E' class='anchor'></a></h3><div class='impl-items'><h4 id='associatedtype.Output' class="type"><code>type <a href='#associatedtype.Output' class="type">Output</a> = T</code></h4><div class='docblock'><p>Should always be <code>Self</code></p>
</div></div><h3 id='impl-TryFrom%3CU%3E' class='impl'><code class='in-band'>impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;T&gt;,&nbsp;</span></code><a href='#impl-TryFrom%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#607-616' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error' class="type"><code>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error' class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>