mirror of
https://github.com/actix/actix-website
synced 2024-11-28 10:32:38 +01:00
45 lines
21 KiB
HTML
45 lines
21 KiB
HTML
|
<!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="API documentation for the Rust `TestServer` struct in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, TestServer"><title>actix_web::test::TestServer - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><p class='location'>Struct TestServer</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.build">build</a><a href="#method.build_with_state">build_with_state</a><a href="#method.with_factory">with_factory</a><a href="#method.unused_addr">unused_addr</a><a href="#method.addr">addr</a><a href="#method.url">url</a><a href="#method.execute">execute</a><a href="#method.ws">ws</a><a href="#method.get">get</a><a href="#method.post">post</a><a href="#method.head">head</a><a href="#method.client">client</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Drop">Drop</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">!Send</a><a href="#impl-Sync">!Sync</a></div></div><p class='location'><a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>test</a></p><script>window.sidebarCurrent = {name: 'TestServer', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Struct <a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>test</a>::<wbr><a class="struct" href=''>TestServer</a></span><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../../src/actix_web/test.rs.html#62-67' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct TestServer { /* fields omitted */ }</pre></div><div class='docblock'><p>The <code>TestServer</code> type.</p>
|
|||
|
|
<p><code>TestServer</code> is very simple test server that simplify process of writing
|
|||
|
|
integration tests cases for actix web applications.</p>
|
|||
|
|
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">actix_web</span>::<span class="ident">test</span>::<span class="ident">TestServer</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">srv</span> <span class="op">=</span> <span class="ident">TestServer</span>::<span class="ident">new</span>(<span class="op">|</span><span class="ident">app</span><span class="op">|</span> <span class="ident">app</span>.<span class="ident">handler</span>(<span class="ident">my_handler</span>));
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="ident">req</span> <span class="op">=</span> <span class="ident">srv</span>.<span class="ident">get</span>().<span class="ident">finish</span>().<span class="ident">unwrap</span>();
|
|||
|
|
<span class="kw">let</span> <span class="ident">response</span> <span class="op">=</span> <span class="ident">srv</span>.<span class="ident">execute</span>(<span class="ident">req</span>.<span class="ident">send</span>()).<span class="ident">unwrap</span>();
|
|||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">response</span>.<span class="ident">status</span>().<span class="ident">is_success</span>());</pre>
|
|||
|
|
</div>
|
|||
|
|
<h2 id='methods' class='small-section-header'>
|
|||
|
|
Methods<a href='#methods' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="struct" href="../../actix_web/test/struct.TestServer.html" title="struct actix_web::test::TestServer">TestServer</a></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/test.rs.html#69-228' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.new' class='fnname'>new</a><F>(config: F) -> Self <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static + <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(&mut <a class="struct" href="../../actix_web/test/struct.TestApp.html" title="struct actix_web::test::TestApp">TestApp</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>), </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/test.rs.html#74-79' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Start new test server</p>
|
|||
|
|
<p>This method accepts configuration method. You can add
|
|||
|
|
middlewares or set handlers for test application.</p>
|
|||
|
|
</div><h4 id='method.build' class="method"><span id='build.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.build' class='fnname'>build</a>() -> <a class="struct" href="../../actix_web/test/struct.TestServerBuilder.html" title="struct actix_web::test::TestServerBuilder">TestServerBuilder</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/test.rs.html#82-84' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create test server builder</p>
|
|||
|
|
</div><h4 id='method.build_with_state' class="method"><span id='build_with_state.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.build_with_state' class='fnname'>build_with_state</a><F, S>(state: F) -> <a class="struct" href="../../actix_web/test/struct.TestServerBuilder.html" title="struct actix_web::test::TestServerBuilder">TestServerBuilder</a><S> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>() -> S + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static,<br> S: 'static, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/test.rs.html#91-97' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create test server builder with specific state factory</p>
|
|||
|
|
<p>This method can be used for constructing application state.
|
|||
|
|
Also it can be used for external dependency initialization,
|
|||
|
|
like creating sync actors for diesel integration.</p>
|
|||
|
|
</div><h4 id='method.with_factory' class="method"><span id='with_factory.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.with_factory' class='fnname'>with_factory</a><F, U, H>(factory: F) -> Self <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>() -> U + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static,<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a><Item = H> + 'static,<br> H: <a class="trait" href="../../actix_web/server/trait.IntoHttpHandler.html" title="trait actix_web::server::IntoHttpHandler">IntoHttpHandler</a> + 'static, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/test.rs.html#100-132' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Start new test server with application factory</p>
|
|||
|
|
</div><h4 id='method.unused_addr' class="method"><span id='unused_addr.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.unused_addr' class='fnname'>unused_addr</a>() -> <a class="enum" href="https://doc.rust-lang.org/nightly/std/net/addr/enum.SocketAddr.html" title="enum std::net::addr::SocketAddr">SocketAddr</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/test.rs.html#150-157' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Get firat available unused address</p>
|
|||
|
|
</div><h4 id='method.addr' class="method"><span id='addr.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.addr' class='fnname'>addr</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/std/net/addr/enum.SocketAddr.html" title="enum std::net::addr::SocketAddr">SocketAddr</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/test.rs.html#160-162' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Construct test server url</p>
|
|||
|
|
</div><h4 id='method.url' class="method"><span id='url.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.url' class='fnname'>url</a>(&self, uri: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/test.rs.html#165-181' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Construct test server url</p>
|
|||
|
|
</div><h4 id='method.execute' class="method"><span id='execute.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.execute' class='fnname'>execute</a><F, I, E>(&mut self, fut: F) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><I, E> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://docs.rs/futures/0.1/futures/future/trait.Future.html" title="trait futures::future::Future">Future</a><Item = I, Error = E>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/test.rs.html#189-194' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Execute future on current core</p>
|
|||
|
|
</div><h4 id='method.ws' class="method"><span id='ws.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.ws' class='fnname'>ws</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="struct" href="../../actix_web/ws/struct.ClientReader.html" title="struct actix_web::ws::ClientReader">ClientReader</a>, <a class="struct" href="../../actix_web/ws/struct.ClientWriter.html" title="struct actix_web::ws::ClientWriter">ClientWriter</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>, <a class="enum" href="../../actix_web/ws/enum.ClientError.html" title="enum actix_web::ws::ClientError">ClientError</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/test.rs.html#197-203' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Connect to websocket server</p>
|
|||
|
|
</div><h4 id='method.get' class="method"><span id='get.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.get' class='fnname'>get</a>(&self) -> <a class="struct" href="../../actix_web/client/struct.ClientRequestBuilder.html" title="struct actix_web::client::ClientRequestBuilder">ClientRequestBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/test.rs.html#206-208' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create <code>GET</code> request</p>
|
|||
|
|
</div><h4 id='method.post' class="method"><span id='post.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.post' class='fnname'>post</a>(&self) -> <a class="struct" href="../../actix_web/client/struct.ClientRequestBuilder.html" title="struct actix_web::client::ClientRequestBuilder">ClientRequestBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/test.rs.html#211-213' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create <code>POST</code> request</p>
|
|||
|
|
</div><h4 id='method.head' class="method"><span id='head.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.head' class='fnname'>head</a>(&self) -> <a class="struct" href="../../actix_web/client/struct.ClientRequestBuilder.html" title="struct actix_web::client::ClientRequestBuilder">ClientRequestBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/test.rs.html#216-218' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create <code>HEAD</code> request</p>
|
|||
|
|
</div><h4 id='method.client' class="method"><span id='client.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.client' class='fnname'>client</a>(&self, meth: <a class="struct" href="../../actix_web/http/struct.Method.html" title="struct actix_web::http::Method">Method</a>, path: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="struct" href="../../actix_web/client/struct.ClientRequestBuilder.html" title="struct actix_web::client::ClientRequestBuilder">ClientRequestBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/test.rs.html#221-227' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Connect to test http server</p>
|
|||
|
|
</div></div>
|
|||
|
|
<h2 id='implementations' class='small-section-header'>
|
|||
|
|
Trait Implementations<a href='#implementations' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<div id='implementations-list'><h3 id='impl-Drop' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop">Drop</a> for <a class="struct" href="../../actix_web/test/struct.TestServer.html" title="struct actix_web::test::TestServer">TestServer</a></code><a href='#impl-Drop' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/test.rs.html#230-234' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.drop' class="method"><span id='drop.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop' class='fnname'>drop</a>(&mut self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/test.rs.html#231-233' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Executes the destructor for this type. <a href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop">Read more</a></p>
|
|||
|
|
</div></div></div>
|
|||
|
|
<h2 id='synthetic-implementations' class='small-section-header'>
|
|||
|
|
Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<div id='synthetic-implementations-list'>
|
|||
|
|
<h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../actix_web/test/struct.TestServer.html" title="struct actix_web::test::TestServer">TestServer</a></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../actix_web/test/struct.TestServer.html" title="struct actix_web::test::TestServer">TestServer</a></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "actix_web";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
|