<!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="stylesheet"type="text/css"href="../normalize.css"><linkrel="stylesheet"type="text/css"href="../rustdoc.css"id="mainThemeStyle"><linkrel="stylesheet"type="text/css"href="../light.css"id="themeStyle"><linkrel="stylesheet"type="text/css"href="../dark.css"disabled><linkrel="stylesheet"type="text/css"href="../ayu.css"disabled><scriptid="default-settings"></script><scriptsrc="../storage.js"></script><scriptsrc="../crates.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"><styletype="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></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="sidebar"><divclass="sidebar-menu"role="button">☰</div><ahref='../actix_redis/index.html'><divclass='logo-container rust-logo'><imgsrc='../rust-logo.png'alt='logo'></div></a><h2class="location">Struct RedisActor</h2><divclass="sidebar-elems"><divclass="block items"><h3class="sidebar-title"><ahref="#implementations">Methods</a></h3><divclass="sidebar-links"><ahref="#method.start">start</a></div><h3class="sidebar-title"><ahref="#trait-implementations">Trait Implementations</a></h3><divclass="sidebar-links"><ahref="#impl-Actor">Actor</a><ahref="#impl-Handler%3CCommand%3E">Handler<Command></a><ahref="#impl-StreamHandler%3CResult%3CRespValue%2C%20Error%3E%3E">StreamHandler<Result<RespValue, Error>></a><ahref="#impl-Supervised">Supervised</a><ahref="#impl-WriteHandler%3CError%3E">WriteHandler<Error></a></div><h3class="sidebar-title"><ahref="#synthetic-implementations">Auto Trait Implementations</a></h3><divclass="sidebar-links"><ahref="#impl-RefUnwindSafe">!RefUnwindSafe</a><ahref="#impl-Send">!Send</a><ahref="#impl-Sync">!Sync</a><ahref="#impl-Unpin">Unpin</a><ahref="#impl-UnwindSafe">!UnwindSafe</a></div><h3class="sidebar-title"><ahref="#blanket-implementations">Blanket Implementations</a></h3><divclass="sidebar-links"><ahref="#impl-Any">Any</a><ahref="#impl-Borrow%3CT%3E">Borrow<T></a><ahref="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><ahref="#impl-From%3CT%3E">From<T></a><ahref="#impl-Instrument">Instrument</a><ahref="#impl-Into%3CU%3E">Into<U></a><ahref="#impl-Same%3CT%3E">Same<T></a><ahref="#impl-TryFrom%3CU%3E">TryFrom<U></a><ahref="#impl-TryInto%3CU%3E">TryInto<U></a><ahref="#impl-VZip%3CV%3E">VZip<V></a><ahref="#impl-WithSubscriber">WithSubscriber</a></div></div><h2class="location">Other items in<br><ahref="index.html">actix_redis</a></h2><divid="sidebar-vars"data-name="RedisActor"data-ty="struct"data-relpath=""></div><scriptdefersrc="sidebar-items.js"></script></div></nav><divclass="theme-picker"><buttonid="theme-picker"aria-label="Pick another theme!"aria-haspopup="menu"title="themes"><imgwidth="18"height="18"alt="Pick another theme!"src="../brush.svg"></button><divid="theme-choices"role="menu"></div></div><navclass="sub"><formclass="search-form"><divclass="search-container"><div><selectid="crate-search"><optionvalue="All crates">All crates</option></select><inputclass="search-input"name="search"disabledautocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"></div><buttontype="button"id="help-button"title="help">?</button><aid="settings-menu"href="../settings.html"tit
</div></details></div></details><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><divid="impl-Actor"class="impl has-srclink"><divclass="rightside"><aclass="srclink"href="../src/actix_redis/redis.rs.html#56-91"title="goto source code">[src]</a></div><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></div></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><divid="associatedtype.Context"class="type trait-impl has-srclink"><ahref="#associatedtype.Context"class="anchor"></a><h4class="code-header">type <ahref="#associatedtype.Context"class="type">Context</a> = Context<Self></h4></div></summary><divclass='docblock'><p>Actor execution context type</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.started"class="method trait-impl has-srclink"><divclass="rightside"><aclass="srclink"href="../src/actix_redis/redis.rs.html#59-90"title="goto source code">[src]</a></div><ahref="#method.started"class="anchor"></a><h4class="code-header">fn <ahref="#method.started"class="fnname">started</a>(&mut self, ctx: &mut Context<Self>)</h4></div></summary><divclass='docblock'><p>Called when an actor gets polled the first time.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.stopping"class="method trait-impl has-srclink"><divclass="rightside"></div><ahref="#method.stopping"class="anchor"></a><h4class="code-header">fn <ahref="#method.stopping"class="fnname">stopping</a>(&mut self, ctx: &mut Self::Context) -> Running</h4></div></summary><divclass='docblock'><p>Called after an actor is in <code>Actor::Stopping</code> state. <ahref="#method.stopping">Read more</a></p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.stopped"class="method trait-impl has-srclink"><divclass="rightside"></div><ahref="#method.stopped"class="anchor"></a><h4class="code-header">fn <ahref="#method.stopped"class="fnname">stopped</a>(&mut self, ctx: &mut Self::Context)</h4></div></summary><divclass='docblock'><p>Called after an actor is stopped. <ahref="#method.stopped">Read more</a></p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.start-1"class="method trait-impl has-srclink"><divclass="rightside"></div><ahref="#method.start-1"class="anchor"></a><h4class="code-header">fn <ahref="#method.start"class="fnname">start</a>(self) -> Addr<Self><spanclass="where fmt-newline">where<br> Self: Actor<Context = Context<Self>>, </span></h4></div></summary><divclass='docblock'><p>Start a new asynchronous actor, returning its address. <ahref="#method.start">Read more</a></p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.start_default"class="method trait-impl has-srclink"><divclass="rightside"></div><ahref="#method.start_default"class="anchor"></a><h4class="code-header">fn <ahref="#method.start_default"class="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></div></summary><divclass='docblock'><p>Construct and start a new asynchronous actor, returning its
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.create"class="method trait-impl has-srclink"><divclass="rightside"></div><ahref="#method.create"class="anchor"></a><h4class="code-header">fn <ahref="#method.create"class="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></div></summary><divclass='docblock'><p>Start a new asynchronous actor given a <code>Context</code>. <ahref="#method.create">Read more</a></p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"open><summary><divid="impl-Handler%3CCommand%3E"class="impl has-srclink"><divclass="rightside"><aclass="srclink"href="../src/actix_redis/redis.rs.html#127-141"title="goto source code">[src]</a></div><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></div></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><divid="associatedtype.Result"class="type trait-impl has-srclink"><ahref="#associatedtype.Result"class="anchor"></a><h4class="code-header">type <ahref="#associatedtype.Result"class="type">Result</a> = ResponseFuture<<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>>></h4></div></summary><divclass='docblock'><p>The type of value that this handler will return. <ahref="#associatedtype.Result">Read more</a></p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.handle"class="method trait-impl has-srclink"><divclass="rightside"><aclass="srclink"href="../src/actix_redis/redis.rs.html#130-140"title="goto source code">[src]</a></div><ahref="#method.handle"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></div></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><divid="impl-StreamHandler%3CResult%3CRespValue%2C%20Error%3E%3E"class="impl has-srclink"><divclass="rightside"><aclass="srclink"href="../src/actix_redis/redis.rs.html#109-125"title="goto source code">[src]</a></div><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></div></summary><divclass="impl-items"><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.handle-1"class="method trait-impl has-srclink"><divclass="rightside"><aclass="srclink"href="../src/actix_redis/redis.rs.html#110-124"title="goto source code">[src]</a></div><ahref="#method.handle-1"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></div></summary><divclass='docblock'><p>Called for every message emitted by the stream.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.started-1"class="method trait-impl has-srclink"><divclass="rightside"></div><ahref="#method.started-1"class="anchor"></a><h4class="code-header">fn <ahref="#method.started"class="fnname">started</a>(&mut self, ctx: &mut Self::Context)</h4></div></summary><divclass='docblock'><p>Called when stream emits first item. <ahref="#method.started">Read more</a></p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"open><summary><divid="impl-Instrument"class="impl has-srclink"><divclass="rightside"><aclass="srclink"href="https://docs.rs/tracing/0.1.29/src/tracing/instrument.rs.html#276"title="goto source code">[src]</a></div><ahref="#impl-Instrument"class="anchor"></a><h3class="code-header in-band">impl<T><aclass="trait"href="https://docs.rs/tracing/0.1.29/tracing/instrument/trait.Instrument.html"title="trait tracing::instrument::Instrument">Instrument</a> for T</h3></div></summary><divclass="impl-items"><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.instrument"class="method trait-impl has-srclink"><divclass="rightside"><aclass="srclink"href="https://docs.rs/tracing/0.1.29/src/tracing/instrument.rs.html#82"title="goto source code">[src]</a></div><ahref="#method.instrument"class="anchor"></a><h4class="code-header">fn <ahref="https://docs.rs/tracing/0.1.29/tracing/instrument/trait.Instrument.html#method.instrument"class="fnname">instrument</a>(self, span: <aclass="struct"href="https://docs.rs/tracing/0.1.29/tracing/span/struct.Span.html"title="struct tracing::span::Span">Span</a>) -><aclass="struct"href="https://docs.rs/tracing/0.1.29/tracing/instrument/struct.Instrumented.html"title="struct tracing::instrument::Instrumented">Instrumented</a><Self></h4></div></summary><divclass='docblock'><p>Instruments this type with the provided <ahref="https://docs.rs/tracing/0.1.29/tracing/span/struct.Span.html"title="Span"><code>Span</code></a>, returning an
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.in_current_span"class="method trait-impl has-srclink"><divclass="rightside"><aclass="srclink"href="https://docs.rs/tracing/0.1.29/src/tracing/instrument.rs.html#121"title="goto source code">[src]</a></div><ahref="#method.in_current_span"class="anchor"></a><h4class="code-header">fn <ahref="https://docs.rs/tracing/0.1.29/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.29/tracing/instrument/struct.Instrumented.html"title="struct tracing::instrument::Instrumented">Instrumented</a><Self></h4></div></summary><divclass='docblock'><p>Instruments this type with the <ahref="https://docs.rs/tracing/0.1.29/tracing/span/struct.Span.html#method.current">current</a><ahref="https://docs.rs/tracing/0.1.29/tracing/span/struct.Span.html"><code>Span</code></a>, returning an
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"open><summary><divid="impl-TryFrom%3CU%3E"class="impl has-srclink"><divclass="rightside"><aclass="srclink"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#587-596"title="goto source code">[src]</a></div><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></div></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><divid="associatedtype.Error"class="type trait-impl has-srclink"><ahref="#associatedtype.Error"class="anchor"></a><h4class="code-header">type <ahref="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"class="type">Error</a> = <aclass="enum"href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html"title="enum core::convert::Infallible">Infallible</a></h4></div></summary><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.try_from"class="method trait-impl has-srclink"><divclass="rightside"><aclass="srclink"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#593"title="goto source code">[src]</a></div><ahref="#method.try_from"class="anchor"></a><h4class="code-header">pub fn <ahref="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from"class="fnname">try_from</a>(value: U) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><T, <T as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U>>::<aclass="type"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></h4></div></summary><divclass='docblock'><p>Performs the conversion.</p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"open><summary><divid="impl-TryInto%3CU%3E"class="impl has-srclink"><divclass="rightside"><aclass="srclink"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#573-582"title="goto source code">[src]</a></div><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></div></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><divid="associatedtype.Error-1"class="type 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.TryInto.html#associatedtype.Error"class="type">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="type"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a></h4></div></summary><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.try_into"class="method trait-impl has-srclink"><divclass="rightside"><aclass="srclink"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#579"title="goto source code">[src]</a></div><ahref="#method.try_into"class="anchor"></a><h4class="code-header">pub fn <ahref="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into"class="fnname">try_into</a>(self) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><U, <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="type"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></h4></div></summary><divclass='docblock'><p>Performs the conversion.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.with_current_subscriber"class="method trait-impl has-srclink"><divclass="rightside"><aclass="srclink"href="https://docs.rs/tracing/0.1.29/src/tracing/instrument.rs.html#221"title="goto source code">[src]</a></div><ahref="#method.with_current_subscriber"class="anchor"></a><h4class="code-header">fn <ahref="https://docs.rs/tracing/0.1.29/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.29/tracing/instrument/struct.WithDispatch.html"title="struct tracing::instrument::WithDispatch">WithDispatch</a><Self></h4></div></summary><divclass='docblock'><p>Attaches the current <ahref="https://docs.rs/tracing/0.1.29/tracing/dispatcher/index.html#setting-the-default-subscriber">default</a><ahref="https://docs.rs/tracing-core/0.1.21/tracing_core/subscriber/trait.Subscriber.html"><code>Subscriber</code></a> to this type, returning a
