<!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="API documentation for the Rust `RedisActor` struct in crate `actix_redis`."><metaname="keywords"content="rust, rustlang, rust-lang, RedisActor"><title>actix_redis::RedisActor - 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="../dark.css"><linkrel="stylesheet"type="text/css"href="../light.css"id="themeStyle"><scriptsrc="../storage.js"></script><noscript><linkrel="stylesheet"href="../noscript.css"></noscript><linkrel="shortcut icon"href="../favicon.ico"><styletype="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><bodyclass="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="sidebar"><divclass="sidebar-menu">☰</div><ahref='../actix_redis/index.html'><divclass='logo-container'><imgsrc='../rust-logo.png'alt='logo'></div></a><pclass='location'>Struct RedisActor</p><divclass="sidebar-elems"><divclass="block items"><aclass="sidebar-title"href="#implementations">Methods</a><divclass="sidebar-links"><ahref="#method.start">start</a></div><aclass="sidebar-title"href="#trait-implementations">Trait Implementations</a><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><aclass="sidebar-title"href="#synthetic-implementations">Auto Trait Implementations</a><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><aclass="sidebar-title"href="#blanket-implementations">Blanket Implementations</a><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></div></div><pclass='location'><ahref='index.html'>actix_redis</a></p><script>window.sidebarCurrent={name:'RedisActor',ty:'struct',relpath:''};</script><scriptdefersrc="sidebar-items.js"></script></div></nav><divclass="theme-picker"><buttonid="theme-picker"aria-label="Pick another theme!"><imgsrc="../brush.svg"width="18"alt="Pick another theme!"></button><divid="theme-choices"></div></div><scriptsrc="../theme.js"></script><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><aid="settings-menu"href="../settings.html"><imgsrc="../wheel.svg"width="18"alt="Change settings"></a></div></form></nav><sectionid="main"class="content"><h1class='fqn'><spanclass='out-of-band'><spanid='render-detail'><aid="toggle-all-docs"href="javascript:void(0)"title="collapse all docs">[<spanclass='inner'>−</span>]</a></span><aclass='srclink'href='../src/actix_redis/redis.rs.html#28-33'title='goto source code'>[src]</a></span><spanclass='in-band'>Struct <ahref='index.html'>actix_redis</a>::<w
</div><h2id='implementations'class='small-section-header'>Implementations<ahref='#implementations'class='anchor'></a></h2><h3id='impl'class='impl'><codeclass='in-band'>impl <aclass="struct"href="../actix_redis/struct.RedisActor.html"title="struct actix_redis::RedisActor">RedisActor</a></code><ahref='#impl'class='anchor'></a><aclass='srclink'href='../src/actix_redis/redis.rs.html#35-50'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.start'class="method"><code>pub fn <ahref='#method.start'class='fnname'>start</a><S: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><<aclass="struct"href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html"title="struct alloc::string::String">String</a>>>(addr: S) -> Addr<<aclass="struct"href="../actix_redis/struct.RedisActor.html"title="struct actix_redis::RedisActor">RedisActor</a>></code><aclass='srclink'href='../src/actix_redis/redis.rs.html#37-49'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Start new <code>Supervisor</code> with <code>RedisActor</code>.</p>
</div></div><h2id='trait-implementations'class='small-section-header'>Trait Implementations<ahref='#trait-implementations'class='anchor'></a></h2><divid='trait-implementations-list'><h3id='impl-Actor'class='impl'><codeclass='in-band'>impl Actor for <aclass="struct"href="../actix_redis/struct.RedisActor.html"title="struct actix_redis::RedisActor">RedisActor</a></code><ahref='#impl-Actor'class='anchor'></a><aclass='srclink'href='../src/actix_redis/redis.rs.html#52-95'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='associatedtype.Context'class="type"><code>type <ahref='#associatedtype.Context'class="type">Context</a> = Context<Self></code></h4><divclass='docblock'><p>Actor execution context type</p>
</div><h4id='method.started'class="method hidden"><code>fn <ahref='#method.started'class='fnname'>started</a>(&mut self, ctx: &mut Context<Self>)</code><aclass='srclink'href='../src/actix_redis/redis.rs.html#55-94'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Called when an actor gets polled the first time.</p>
</div><h4id='method.stopping'class="method hidden"><code>fn <ahref='#method.stopping'class='fnname'>stopping</a>(&mut self, ctx: &mut Self::Context) -> Running</code></h4><divclass='docblock hidden'><p>Called after an actor is in <code>Actor::Stopping</code> state. <ahref="#method.stopping">Read more</a></p>
</div><h4id='method.stopped'class="method hidden"><code>fn <ahref='#method.stopped'class='fnname'>stopped</a>(&mut self, ctx: &mut Self::Context)</code></h4><divclass='docblock hidden'><p>Called after an actor is stopped. <ahref="#method.stopped">Read more</a></p>
</div><h4id='method.start-1'class="method hidden"><code>fn <ahref='#method.start'class='fnname'>start</a>(self) -> Addr<Self><spanclass="where fmt-newline">where<br> Self: Actor<Context = Context<Self>>, </span></code></h4><divclass='docblock hidden'><p>Start a new asynchronous actor, returning its address. <ahref="#method.start">Read more</a></p>
</div><h4id='method.start_default'class="method hidden"><code>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></code></h4><divclass='docblock hidden'><p>Construct and start a new asynchronous actor, returning its address. <ahref="#method.start_default">Read more</a></p>
</div><h4id='method.start_in_arbiter'class="method hidden"><code>fn <ahref='#method.start_in_arbiter'class='fnname'>start_in_arbiter</a><F>(arb: &Arbiter, f: F) -> Addr<Self><spanclass="where fmt-newline">where<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 + <aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html"title="trait core::marker::Send">Send</a> + 'static,<br> Self: Actor<Context = Context<Self>>, </span></code></h4><divclass='docblock hidden'><p>Start new actor in arbiter's thread.</p>
</div><h4id='method.create'class="method hidden"><code>fn <ahref='#method.create'class='fnname'>create</a><F>(f: F) -> Addr<Self><spanclass="where fmt-newline">where<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,<br> Self: Actor<Context = Context<Self>>, </span></code></h4><divclass='docblock hidden'><p>Start a new asynchronous actor given a <code>Context</code>. <ahref="#method.create">Read more</a></p>
</div></div><h3id='impl-Handler%3CCommand%3E'class='impl'><codeclass='in-band'>impl Handler<<aclass="struct"href="../actix_redis/struct.Command.html"title="struct actix_redis::Command">Command</a>> for <aclass="struct"href="../actix_redis/struct.RedisActor.html"title="struct actix_redis::RedisActor">RedisActor</a></code><ahref='#impl-Handler%3CCommand%3E'class='anchor'></a><aclass='srclink'href='../src/actix_redis/redis.rs.html#131-148'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='associatedtype.Result'class="type"><code>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="../actix_redis/enum.RespValue.html"title="enum actix_redis::RespValue">RespValue</a>, <aclass="enum"href="../actix_redis/enum.Error.html"title="enum actix_redis::Error">Error</a>>></code></h4><divclass='docblock'><p>The type of value that this handler will return. <ahref="#associatedtype.Result">Read more</a></p>
</div><h4id='method.handle'class="method hidden"><code>fn <ahref='#method.handle'class='fnname'>handle</a>(&mut self, msg: <aclass="struct"href="../actix_redis/struct.Command.html"title="struct actix_redis::Command">Command</a>, _: &mut Self::Context) -> Self::Result</code><aclass='srclink'href='../src/actix_redis/redis.rs.html#134-147'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>This method is called for every message received by this actor.</p>
</div></div><h3id='impl-StreamHandler%3CResult%3CRespValue%2C%20Error%3E%3E'class='impl'><codeclass='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="../actix_redis/enum.RespValue.html"title="enum actix_redis::RespValue">RespValue</a>, <aclass="enum"href="../actix_redis/enum.RespError.html"title="enum actix_redis::RespError">Error</a>>> for <aclass="struct"href="../actix_redis/struct.RedisActor.html"title="struct actix_redis::RedisActor">RedisActor</a></code><ahref='#impl-StreamHandler%3CResult%3CRespValue%2C%20Error%3E%3E'class='anchor'></a><aclass='srclink'href='../src/actix_redis/redis.rs.html#113-129'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.handle-1'class="method hidden"><code>fn <ahref='#method.handle'class='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="../actix_redis/enum.RespValue.html"title="enum actix_redis::RespValue">RespValue</a>, <aclass="enum"href="../actix_redis/enum.RespError.html"title="enum actix_redis::RespError">RespError</a>>, ctx: &mut Self::Context)</code><aclass='srclink'href='../src/actix_redis/redis.rs.html#114-128'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Method is called for every message received by this Actor</p>
</div><h4id='method.started-1'class="method hidden"><code>fn <ahref='#method.started'class='fnname'>started</a>(&mut self, ctx: &mut Self::Context)</code></h4><divclass='docblock hidden'><p>Method is called when stream get polled first time.</p>
</div><h4id='method.finished'class="method hidden"><code>fn <ahref='#method.finished'class='fnname'>finished</a>(&mut self, ctx: &mut Self::Context)</code></h4><divclass='docblock hidden'><p>Method is called when stream finishes. <ahref="#method.finished">Read more</a></p>
</div><h4id='method.add_stream'class="method hidden"><code>fn <ahref='#method.add_stream'class='fnname'>add_stream</a><S>(fut: S, ctx: &mut Self::Context) -> SpawnHandle <spanclass="where fmt-newline">where<br> I: 'static,<br> S: <aclass="trait"href="https://docs.rs/futures-core/0.3.6/futures_core/stream/trait.Stream.html"title="trait futures_core::stream::Stream">Stream</a><Item = I> + 'static,<br> Self::Context: AsyncContext<Self>, </span></code></h4><divclass='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. <ahref="#method.add_stream">Read more</a></p>
</div></div><h3id='impl-Instrument'class='impl'><codeclass='in-band'>impl<T><aclass="trait"href="https://docs.rs/tracing/0.1.21/tracing/instrument/trait.Instrument.html"title="trait tracing::instrument::Instrument">Instrument</a> for T</code><ahref='#impl-Instrument'class='anchor'></a><aclass='srclink'href='https://docs.rs/tracing/0.1.21/src/tracing/instrument.rs.html#155'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.instrument'class="method hidden"><code>fn <ahref='https://docs.rs/tracing/0.1.21/tracing/instrument/trait.Instrument.html#method.instrument'class='fnname'>instrument</a>(self, span: <aclass="struct"href="https://docs.rs/tracing/0.1.21/tracing/span/struct.Span.html"title="struct tracing::span::Span">Span</a>) -><aclass="struct"href="https://docs.rs/tracing/0.1.21/tracing/instrument/struct.Instrumented.html"title="struct tracing::instrument::Instrumented">Instrumented</a><Self></code><aclass='srclink'href='https://docs.rs/tracing/0.1.21/src/tracing/instrument.rs.html#38-40'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Instruments this type with the provided <code>Span</code>, returning an <code>Instrumented</code> wrapper. <ahref="https://docs.rs/tracing/0.1.21/tracing/instrument/trait.Instrument.html#method.instrument">Read more</a></p>
</div><h4id='method.in_current_span'class="method hidden"><code>fn <ahref='https://docs.rs/tracing/0.1.21/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.21/tracing/instrument/struct.Instrumented.html"title="struct tracing::instrument::Instrumented">Instrumented</a><Self></code><aclass='srclink'href='https://docs.rs/tracing/0.1.21/src/tracing/instrument.rs.html#74-76'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Instruments this type with the [current] <code>Span</code>, returning an <code>Instrumented</code> wrapper. <ahref="https://docs.rs/tracing/0.1.21/tracing/instrument/trait.Instrument.html#method.in_current_span">Read more</a></p>
</div></div><h3id='impl-Into%3CU%3E'class='impl'><codeclass='in-band'>impl<T, U><aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html"title="trait core::convert::From">From</a><T>, </span></code><ahref='#impl-Into%3CU%3E'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#555-562'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.into'class="method hidden"><code>fn <ahref='https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into'class='fnname'>into</a>(self) -> U</code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#559-561'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3id='impl-Same%3CT%3E'class='impl'><codeclass='in-band'>impl<T> Same<T> for T</code><ahref='#impl-Same%3CT%3E'class='anchor'></a></h3><divclass='impl-items'><h4id='associatedtype.Output'class="type"><code>type <ahref='#associatedtype.Output'class="type">Output</a> = T</code></h4><divclass='docblock'><p>Should always be <code>Self</code></p>
</div></div><h3id='impl-TryFrom%3CU%3E'class='impl'><codeclass='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></code><ahref='#impl-TryFrom%3CU%3E'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#603-612'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='associatedtype.Error'class="type"><code>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></code></h4><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4id='method.try_from'class="method hidden"><code>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>></code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#609-611'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3id='impl-TryInto%3CU%3E'class='impl'><codeclass='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></code><ahref='#impl-TryInto%3CU%3E'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#589-598'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='associatedtype.Error-1'class="type"><code>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></code></h4><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4id='method.try_into'class="method hidden"><code>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>></code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#595-597'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3id='impl-VZip%3CV%3E'class='impl'><codeclass='in-band'>impl<V, T> VZip<V> for T <spanclass="where fmt-newline">where<br> V: MultiLane<T>, </span></code><ahref='#impl-VZip%3CV%3E'class='anchor'></a></h3><divclass='impl-items'><h4id='method.vzip'class="method hidden"><code>fn <ahref='#method.vzip'class='fnname'>vzip</a>(self) -> V</code></h4></div></div></section><sectionid="search"class="content hidden"></section><sectionclass="footer"></section><script>window.rootPath="../";window.currentCrate="actix_redis";</script><scriptsrc="../main.js"></script><scriptdefersrc="../search-index.js"></script></body></html>
