<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="Redis communication actor"><metaname="keywords"content="rust, rustlang, rust-lang, RedisActor"><title>RedisActor in actix_redis - Rust</title><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../SourceSerif4-Regular.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../FiraSans-Regular.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../FiraSans-Medium.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../SourceCodePro-Regular.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../SourceSerif4-Bold.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../SourceCodePro-Semibold.ttf.woff2"><linkrel="stylesheet"type="text/css"href="../normalize.css"><linkrel="stylesheet"type="text/css"href="../rustdoc.css"id="mainThemeStyle"><linkrel="stylesheet"type="text/css"href="../ayu.css"disabled><linkrel="stylesheet"type="text/css"href="../dark.css"disabled><linkrel="stylesheet"type="text/css"href="../light.css"id="themeStyle"><scriptid="default-settings"></script><scriptsrc="../storage.js"></script><scriptdefersrc="sidebar-items.js"></script><scriptdefersrc="../main.js"></script><noscript><linkrel="stylesheet"href="../noscript.css"></noscript><linkrel="alternate icon"type="image/png"href="../favicon-16x16.png"><linkrel="alternate icon"type="image/png"href="../favicon-32x32.png"><linkrel="icon"type="image/svg+xml"href="../favicon.svg"></head><bodyclass="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="mobile-topbar"><buttonclass="sidebar-menu-toggle">☰</button><aclass="sidebar-logo"href="../actix_redis/index.html"><divclass="logo-container"><imgclass="rust-logo"src="../rust-logo.svg"alt="logo"></div>
</a><h2class="location"><ahref="#">RedisActor</a></h2><divclass="sidebar-elems"><section><divclass="block"><h3class="sidebar-title"><ahref="#implementations">Methods</a></h3><ul><li><ahref="#method.start">start</a></li></ul></div><divclass="block"><h3class="sidebar-title"><ahref="#trait-implementations">Trait Implementations</a></h3><ul><li><ahref="#impl-Actor">Actor</a></li><li><ahref="#impl-Handler%3CCommand%3E">Handler<Command></a></li><li><ahref="#impl-StreamHandler%3CResult%3CRespValue%2C%20Error%3E%3E">StreamHandler<Result<RespValue, Error>></a></li><li><ahref="#impl-Supervised">Supervised</a></li><li><ahref="#impl-WriteHandler%3CError%3E">WriteHandler<Error></a></li></ul></div><divclass="block"><h3class="sidebar-title"><ahref="#synthetic-implementations">Auto Trait Implementations</a></h3><ul><li><ahref="#impl-RefUnwindSafe">!RefUnwindSafe</a></li><li><ahref="#impl-Send">!Send</a></li><li><ahref="#impl-Sync">!Sync</a></li><li><ahref="#impl-Unpin">Unpin</a></li><li><ahref="#impl-UnwindSafe">!UnwindSafe</a></li></ul></div><divclass="block"><h3class="sidebar-title"><ahref="#blanket-implementations">Blanket Implementations</a></h3><ul><li><ahref="#impl-Any">Any</a></li><li><ahref="#impl-Borrow%3CT%3E">Borrow<T></a></li><li><ahref="#impl-BorrowMut%3CT%3E">BorrowMut<T></a></li><li><ahref="#impl-From%3CT%3E">From<T></a></li><li><ahref="#impl-Instrument">Instrument</a></li><li><ahref="#impl-Into%3CU%3E">Into<U></a></li><li><ahref="#impl-Same%3CT%3E">Same<T></a></li><li><ahref="#impl-TryFrom%3CU%3E">TryFrom<U></a></li><li><ahref="#impl-TryInto%3CU%3E">TryInto<U></a></li><li><ahref="#impl-VZip%3CV%3E">VZip<V></a></li><li><ahref="#impl-WithSubscriber">WithSubscriber</a></li></ul></div></section><h2class="location"><ahref="index.html">In actix_redis</a></h2></div></nav><main><divclass="width-limiter"><divclass="sub-container"><aclass="sub-logo-container"href="../actix_redis/index.html"><imgclass="rust-logo"src="../rust-logo.svg"alt="logo"></a><navclass="sub"><formclass="search-form"><divclass="search-container"><span></span><inputclass="search-input"name="search"autocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"><buttontype="button"id="help-button"title="help">?</button><divid="settings-menu"tabindex="-1">
</div></details></div></details></div><h2id="trait-implementations"class="small-section-header">Trait Implementations<ahref="#trait-implementations"class="anchor"></a></h2><divid="trait-implementations-list"><detailsclass="rustdoc-toggle implementors-toggle"open><summary><sectionid="impl-Actor"class="impl has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/actix_redis/redis.rs.html#56-91">source</a></span><ahref="#impl-Actor"class="anchor"></a><h3class="code-header in-band">impl Actor for <aclass="struct"href="struct.RedisActor.html"title="struct actix_redis::RedisActor">RedisActor</a></h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><sectionid="associatedtype.Context"class="associatedtype trait-impl has-srclink"><ahref="#associatedtype.Context"class="anchor"></a><h4class="code-header">type <aclass="associatedtype">Context</a> = Context<<aclass="struct"href="struct.RedisActor.html"title="struct actix_redis::RedisActor">RedisActor</a>></h4></section></summary><divclass='docblock'><p>Actor execution context type</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.started"class="method trait-impl has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/actix_redis/redis.rs.html#59-90">source</a></span><ahref="#method.started"class="anchor"></a><h4class="code-header">fn <aclass="fnname">started</a>(&mut self, ctx: &mut Context<Self>)</h4></section></summary><divclass='docblock'><p>Called when an actor gets polled the first time.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.stopping"class="method trait-impl has-srclink"><ahref="#method.stopping"class="anchor"></a><h4class="code-header">fn <aclass="fnname">stopping</a>(&mut self, ctx: &mut Self::Context) -> Running</h4></section></summary><divclass='docblock'><p>Called after an actor is in <code>Actor::Stopping</code> state. <a>Read more</a></p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.stopped"class="method trait-impl has-srclink"><ahref="#method.stopped"class="anchor"></a><h4class="code-header">fn <aclass="fnname">stopped</a>(&mut self, ctx: &mut Self::Context)</h4></section></summary><divclass='docblock'><p>Called after an actor is stopped. <a>Read more</a></p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.start-1"class="method trait-impl has-srclink"><ahref="#method.start-1"class="anchor"></a><h4class="code-header">fn <aclass="fnname">start</a>(self) -> Addr<Self><spanclass="where fmt-newline">where<br> Self: Actor<Context = Context<Self>>, </span></h4></section></summary><divclass='docblock'><p>Start a new asynchronous actor, returning its address. <a>Read more</a></p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.start_default"class="method trait-impl has-srclink"><ahref="#method.start_default"class="anchor"></a><h4class="code-header">fn <aclass="fnname">start_default</a>() -> Addr<Self><spanclass="where fmt-newline">where<br> Self: Actor<Context = Context<Self>> + <aclass="trait"href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html"title="trait core::default::Default">Default</a>, </span></h4></section></summary><divclass='docblock'><p>Construct and start a new asynchronous actor, returning its
address. <a>Read more</a></p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.start_in_arbiter"class="method trait-impl has-srclink"><ahref="#method.start_in_arbiter"class="anchor"></a><h4class="code-header">fn <aclass="fnname">start_in_arbiter</a><F>(wrk: &ArbiterHandle, f: F) -> Addr<Self><spanclass="where fmt-newline">where<br> Self: Actor<Context = Context<Self>>,<br> F: 'static + <aclass="trait"href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html"title="trait core::ops::function::FnOnce">FnOnce</a>(&mut Context<Self>) -> Self + <aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html"title="trait core::marker::Send">Send</a>, </span></h4></section></summary><divclass='docblock'><p>Start new actor in arbiter’s thread.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.create"class="method trait-impl has-srclink"><ahref="#method.create"class="anchor"></a><h4class="code-header">fn <aclass="fnname">create</a><F>(f: F) -> Addr<Self><spanclass="where fmt-newline">where<br> Self: Actor<Context = Context<Self>>,<br> F: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html"title="trait core::ops::function::FnOnce">FnOnce</a>(&mut Context<Self>) -> Self, </span></h4></section></summary><divclass='docblock'><p>Start a new asynchronous actor given a <code>Context</code>. <a>Read more</a></p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"open><summary><sectionid="impl-Handler%3CCommand%3E"class="impl has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/actix_redis/redis.rs.html#127-141">source</a></span><ahref="#impl-Handler%3CCommand%3E"class="anchor"></a><h3class="code-header in-band">impl Handler<<aclass="struct"href="struct.Command.html"title="struct actix_redis::Command">Command</a>> for <aclass="struct"href="struct.RedisActor.html"title="struct actix_redis::RedisActor">RedisActor</a></h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><sectionid="associatedtype.Result"class="associatedtype trait-impl has-srclink"><ahref="#associatedtype.Result"class="anchor"></a><h4class="code-header">type <aclass="associatedtype">Result</a> = <aclass="struct"href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html"title="struct core::pin::Pin">Pin</a><<aclass="struct"href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html"title="struct alloc::boxed::Box">Box</a><dyn <aclass="trait"href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html"title="trait core::future::future::Future">Future</a><Output = <aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="enum"href="enum.RespValue.html"title="enum actix_redis::RespValue">RespValue</a>, <aclass="enum"href="enum.Error.html"title="enum actix_redis::Error">Error</a>>> + 'static, <aclass="struct"href="https://doc.rust-lang.org/nightly/alloc/alloc/struct.Global.html"title="struct alloc::alloc::Global">Global</a>>></h4></section></summary><divclass='docblock'><p>The type of value that this handler will return. <a>Read more</a></p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.handle-1"class="method trait-impl has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/actix_redis/redis.rs.html#130-140">source</a></span><ahref="#method.handle-1"class="anchor"></a><h4class="code-header">fn <aclass="fnname">handle</a>(&mut self, msg: <aclass="struct"href="struct.Command.html"title="struct actix_redis::Command">Command</a>, _: &mut Self::Context) -> Self::Result</h4></section></summary><divclass='docblock'><p>This method is called for every message received by this actor.</p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"open><summary><sectionid="impl-StreamHandler%3CResult%3CRespValue%2C%20Error%3E%3E"class="impl has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/actix_redis/redis.rs.html#109-125">source</a></span><ahref="#impl-StreamHandler%3CResult%3CRespValue%2C%20Error%3E%3E"class="anchor"></a><h3class="code-header in-band">impl StreamHandler<<aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="enum"href="enum.RespValue.html"title="enum actix_redis::RespValue">RespValue</a>, <aclass="enum"href="enum.RespError.html"title="enum actix_redis::RespError">Error</a>>> for <aclass="struct"href="struct.RedisActor.html"title="struct actix_redis::RedisActor">RedisActor</a></h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.handle"class="method trait-impl has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/actix_redis/redis.rs.html#110-124">source</a></span><ahref="#method.handle"class="anchor"></a><h4class="code-header">fn <aclass="fnname">handle</a>(&mut self, msg: <aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="enum"href="enum.RespValue.html"title="enum actix_redis::RespValue">RespValue</a>, <aclass="enum"href="enum.RespError.html"title="enum actix_redis::RespError">RespError</a>>, ctx: &mut Self::Context)</h4></section></summary><divclass='docblock'><p>Called for every message emitted by the stream.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.started-1"class="method trait-impl has-srclink"><ahref="#method.started-1"class="anchor"></a><h4class="code-header">fn <aclass="fnname">started</a>(&mut self, ctx: &mut Self::Context)</h4></section></summary><divclass='docblock'><p>Called when stream emits first item. <a>Read more</a></p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><sectionid="impl-Instrument"class="impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://docs.rs/tracing/0.1.35/src/tracing/instrument.rs.html#276">source</a></span><ahref="#impl-Instrument"class="anchor"></a><h3class="code-header in-band">impl<T><aclass="trait"href="https://docs.rs/tracing/0.1.35/tracing/instrument/trait.Instrument.html"title="trait tracing::instrument::Instrument">Instrument</a> for T</h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.instrument"class="method trait-impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://docs.rs/tracing/0.1.35/src/tracing/instrument.rs.html#82">source</a></span><ahref="#method.instrument"class="anchor"></a><h4class="code-header">fn <ahref="https://docs.rs/tracing/0.1.35/tracing/instrument/trait.Instrument.html#method.instrument"class="fnname">instrument</a>(self, span: <aclass="struct"href="https://docs.rs/tracing/0.1.35/tracing/span/struct.Span.html"title="struct tracing::span::Span">Span</a>) -><aclass="struct"href="https://docs.rs/tracing/0.1.35/tracing/instrument/struct.Instrumented.html"title="struct tracing::instrument::Instrumented">Instrumented</a><Self></h4></section></summary><divclass='docblock'><p>Instruments this type with the provided <ahref="https://docs.rs/tracing/0.1.35/tracing/span/struct.Span.html"title="Span"><code>Span</code></a>, returning an
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.in_current_span"class="method trait-impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://docs.rs/tracing/0.1.35/src/tracing/instrument.rs.html#121">source</a></span><ahref="#method.in_current_span"class="anchor"></a><h4class="code-header">fn <ahref="https://docs.rs/tracing/0.1.35/tracing/instrument/trait.Instrument.html#method.in_current_span"class="fnname">in_current_span</a>(self) -><aclass="struct"href="https://docs.rs/tracing/0.1.35/tracing/instrument/struct.Instrumented.html"title="struct tracing::instrument::Instrumented">Instrumented</a><Self></h4></section></summary><divclass='docblock'><p>Instruments this type with the <ahref="https://docs.rs/tracing/0.1.35/tracing/span/struct.Span.html#method.current">current</a><ahref="https://docs.rs/tracing/0.1.35/tracing/span/struct.Span.html"><code>Span</code></a>, returning an
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><sectionid="impl-Same%3CT%3E"class="impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://docs.rs/typenum/1.15.0/src/typenum/type_operators.rs.html#34-36">source</a></span><ahref="#impl-Same%3CT%3E"class="anchor"></a><h3class="code-header in-band">impl<T><aclass="trait"href="https://docs.rs/typenum/1.15.0/typenum/type_operators/trait.Same.html"title="trait typenum::type_operators::Same">Same</a><T> for T</h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><sectionid="associatedtype.Output"class="associatedtype trait-impl has-srclink"><ahref="#associatedtype.Output"class="anchor"></a><h4class="code-header">type <ahref="https://docs.rs/typenum/1.15.0/typenum/type_operators/trait.Same.html#associatedtype.Output"class="associatedtype">Output</a> = T</h4></section></summary><divclass='docblock'><p>Should always be <code>Self</code></p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><sectionid="impl-TryFrom%3CU%3E"class="impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#598-607">source</a></span><ahref="#impl-TryFrom%3CU%3E"class="anchor"></a><h3class="code-header in-band">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><T>, </span></h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><sectionid="associatedtype.Error-1"class="associatedtype trait-impl has-srclink"><ahref="#associatedtype.Error-1"class="anchor"></a><h4class="code-header">type <ahref="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"class="associatedtype">Error</a> = <aclass="enum"href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html"title="enum core::convert::Infallible">Infallible</a></h4></section></summary><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><sectionid="impl-TryInto%3CU%3E"class="impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#583-592">source</a></span><ahref="#impl-TryInto%3CU%3E"class="anchor"></a><h3class="code-header in-band">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html"title="trait core::convert::TryInto">TryInto</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>, </span></h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><sectionid="associatedtype.Error"class="associatedtype trait-impl has-srclink"><ahref="#associatedtype.Error"class="anchor"></a><h4class="code-header">type <ahref="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error"class="associatedtype">Error</a> = <U as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="associatedtype"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.with_current_subscriber"class="method trait-impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://docs.rs/tracing/0.1.35/src/tracing/instrument.rs.html#221">source</a></span><ahref="#method.with_current_subscriber"class="anchor"></a><h4class="code-header">fn <ahref="https://docs.rs/tracing/0.1.35/tracing/instrument/trait.WithSubscriber.html#method.with_current_subscriber"class="fnname">with_current_subscriber</a>(self) -><aclass="struct"href="https://docs.rs/tracing/0.1.35/tracing/instrument/struct.WithDispatch.html"title="struct tracing::instrument::WithDispatch">WithDispatch</a><Self></h4></section></summary><divclass='docblock'><p>Attaches the current <ahref="https://docs.rs/tracing/0.1.35/tracing/dispatcher/index.html#setting-the-default-subscriber">default</a><ahref="https://docs.rs/tracing-core/0.1.22/tracing_core/subscriber/trait.Subscriber.html"><code>Subscriber</code></a> to this type, returning a
