Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Unknown committed Aug 19, 2023
0 parents commit 76217f2
Show file tree
Hide file tree
Showing 42,854 changed files with 1,922,465 additions and 0 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
Empty file added .lock
Empty file.
Empty file added .nojekyll
Empty file.
11 changes: 11 additions & 0 deletions actix/actor/enum.ActorState.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../actix/prelude/enum.ActorState.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../actix/prelude/enum.ActorState.html">../../actix/prelude/enum.ActorState.html</a>...</p>
<script>location.replace("../../actix/prelude/enum.ActorState.html" + location.search + location.hash);</script>
</body>
</html>
11 changes: 11 additions & 0 deletions actix/actor/enum.Running.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../actix/prelude/enum.Running.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../actix/prelude/enum.Running.html">../../actix/prelude/enum.Running.html</a>...</p>
<script>location.replace("../../actix/prelude/enum.Running.html" + location.search + location.hash);</script>
</body>
</html>
11 changes: 11 additions & 0 deletions actix/actor/struct.SpawnHandle.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../actix/prelude/struct.SpawnHandle.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../actix/prelude/struct.SpawnHandle.html">../../actix/prelude/struct.SpawnHandle.html</a>...</p>
<script>location.replace("../../actix/prelude/struct.SpawnHandle.html" + location.search + location.hash);</script>
</body>
</html>
11 changes: 11 additions & 0 deletions actix/actor/trait.Actor.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../actix/prelude/trait.Actor.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../actix/prelude/trait.Actor.html">../../actix/prelude/trait.Actor.html</a>...</p>
<script>location.replace("../../actix/prelude/trait.Actor.html" + location.search + location.hash);</script>
</body>
</html>
11 changes: 11 additions & 0 deletions actix/actor/trait.ActorContext.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../actix/prelude/trait.ActorContext.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../actix/prelude/trait.ActorContext.html">../../actix/prelude/trait.ActorContext.html</a>...</p>
<script>location.replace("../../actix/prelude/trait.ActorContext.html" + location.search + location.hash);</script>
</body>
</html>
11 changes: 11 additions & 0 deletions actix/actor/trait.AsyncContext.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../actix/prelude/trait.AsyncContext.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../actix/prelude/trait.AsyncContext.html">../../actix/prelude/trait.AsyncContext.html</a>...</p>
<script>location.replace("../../actix/prelude/trait.AsyncContext.html" + location.search + location.hash);</script>
</body>
</html>
11 changes: 11 additions & 0 deletions actix/actor/trait.Supervised.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../actix/prelude/trait.Supervised.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../actix/prelude/trait.Supervised.html">../../actix/prelude/trait.Supervised.html</a>...</p>
<script>location.replace("../../actix/prelude/trait.Supervised.html" + location.search + location.hash);</script>
</body>
</html>
2 changes: 2 additions & 0 deletions actix/actors/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<!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="Helper actors"><title>actix::actors - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-f3501f0f5ae15dfb.css" id="mainThemeStyle"><div id="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="actix" data-themes="" data-resource-suffix="" data-rustdoc-version="1.71.1 (eb26296b5 2023-08-03)" data-search-js="search-4926e5fc22a5646a.js" data-settings-js="settings-de11bff964e9d4e5.js" data-settings-css="settings-8c76f75bfb6bd192.css" data-theme-light-css="light-0f8c037637f9eb3e.css" data-theme-dark-css="dark-1097f8e92a01e3cf.css" data-theme-ayu-css="ayu-614652228113ac93.css" ></div><script src="../../static.files/storage-62ce34ea385b278a.js"></script><script defer src="../../static.files/main-f0540c1d82cde29b.js"></script><noscript><link rel="stylesheet" media="(prefers-color-scheme:light)" href="../../static.files/light-0f8c037637f9eb3e.css"><link rel="stylesheet" media="(prefers-color-scheme:dark)" href="../../static.files/dark-1097f8e92a01e3cf.css"><link rel="stylesheet" href="../../static.files/noscript-13285aec31fa243e.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="logo-container" href="../../actix/index.html"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2></h2></nav><nav class="sidebar"><a class="logo-container" href="../../actix/index.html"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2 class="location"><a href="#">Module actors</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#modules">Modules</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">actix</a>::<wbr><a class="mod" href="#">actors</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/actix/actors/mod.rs.html#1-3">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Helper actors</p>
</div></details><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="mocker/index.html" title="mod actix::actors::mocker">mocker</a></div><div class="desc docblock-short">Mocking utility actor.</div></li></ul></section></div></main></body></html>
24 changes: 24 additions & 0 deletions actix/actors/mocker/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<!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="Mocking utility actor."><title>actix::actors::mocker - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-f3501f0f5ae15dfb.css" id="mainThemeStyle"><div id="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="actix" data-themes="" data-resource-suffix="" data-rustdoc-version="1.71.1 (eb26296b5 2023-08-03)" data-search-js="search-4926e5fc22a5646a.js" data-settings-js="settings-de11bff964e9d4e5.js" data-settings-css="settings-8c76f75bfb6bd192.css" data-theme-light-css="light-0f8c037637f9eb3e.css" data-theme-dark-css="dark-1097f8e92a01e3cf.css" data-theme-ayu-css="ayu-614652228113ac93.css" ></div><script src="../../../static.files/storage-62ce34ea385b278a.js"></script><script defer src="../../../static.files/main-f0540c1d82cde29b.js"></script><noscript><link rel="stylesheet" media="(prefers-color-scheme:light)" href="../../../static.files/light-0f8c037637f9eb3e.css"><link rel="stylesheet" media="(prefers-color-scheme:dark)" href="../../../static.files/dark-1097f8e92a01e3cf.css"><link rel="stylesheet" href="../../../static.files/noscript-13285aec31fa243e.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="logo-container" href="../../../actix/index.html"><img class="rust-logo" src="../../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2></h2></nav><nav class="sidebar"><a class="logo-container" href="../../../actix/index.html"><img class="rust-logo" src="../../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2 class="location"><a href="#">Module mocker</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../../index.html">actix</a>::<wbr><a href="../index.html">actors</a>::<wbr><a class="mod" href="#">mocker</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../../src/actix/actors/mocker.rs.html#1-88">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Mocking utility actor.</p>
<p>This actor wraps any actor, and replaces instances of that actor with
mocker actor, which is able to accept all messages which the actor can
receive.</p>
<p>Mocking is intended to be achieved by using a pattern similar to</p>

<div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested"></a><pre class="rust rust-example-rendered"><code><span class="attr">#[cfg(not(test))]
</span><span class="kw">type </span>DBClientAct = DBClientActor;
<span class="attr">#[cfg(test)]
</span><span class="kw">type </span>DBClientAct = Mocker&lt;DBClientActor&gt;;</code></pre></div>
<p>Then, the actor should be used as a system service (or arbiter service, but
take care that all the places which will use the mocked actor are on the
same arbiter). Thus, in a test, it will retrieve the mocker from the
registry instead of the actual actor.</p>
<p>To set the mock function in the actor, the <code>init_actor</code> function
is used, which allows the state of an actor to be set when it is
started as an arbiter or system service. A closure which takes
<code>Box&lt;Any&gt;</code> is evaluated for every message, and must return
<code>Box&lt;Any&gt;</code>, specifically the return type for the message type
send.</p>
<p>See the mock example to see how it can be used.</p>
</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Mocker.html" title="struct actix::actors::mocker::Mocker">Mocker</a></div><div class="desc docblock-short">This actor is able to wrap another actor and accept all the messages the
wrapped actor can, passing it to a closure which can mock the response of
the actor.</div></li></ul></section></div></main></body></html>
1 change: 1 addition & 0 deletions actix/actors/mocker/sidebar-items.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {"struct":["Mocker"]};
Loading

0 comments on commit 76217f2

Please sign in to comment.