mirror of
https://github.com/actix/actix-web.git
synced 2024-06-02 21:39:26 +00:00
43 lines
5.2 KiB
HTML
43 lines
5.2 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="Helper function that returns a deserialized response body of a TestRequest"><title>call_and_read_body_json in actix_test - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="actix_test" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.0-nightly (bdbbb6c6a 2024-05-26)" data-channel="nightly" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="icon" href="https://actix.rs/favicon.ico"></head><body class="rustdoc fn"><!--[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" title="show sidebar"></button><a class="logo-container" href="../actix_test/index.html"><img src="https://actix.rs/img/logo.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../actix_test/index.html"><img src="https://actix.rs/img/logo.png" alt="logo"></a><h2><a href="../actix_test/index.html">actix_test</a><span class="version">0.1.3</span></h2></div><div class="sidebar-elems"></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Function <a href="index.html">actix_test</a>::<wbr><a class="fn" href="#">call_and_read_body_json</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub async fn call_and_read_body_json<S, B, T>(app: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&S</a>, req: Request) -> T<div class="where">where
|
|
S: Service<Request, Response = ServiceResponse<B>, Error = Error>,
|
|
B: MessageBody,
|
|
T: <a class="trait" href="https://docs.rs/serde/1.0.203/serde/de/trait.DeserializeOwned.html" title="trait serde::de::DeserializeOwned">DeserializeOwned</a>,</div></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Helper function that returns a deserialized response body of a TestRequest</p>
|
|
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>actix_web::{App, test, web, HttpResponse, http::header};
|
|
<span class="kw">use </span>serde::{Serialize, Deserialize};
|
|
|
|
<span class="attr">#[derive(Serialize, Deserialize)]
|
|
</span><span class="kw">pub struct </span>Person {
|
|
id: String,
|
|
name: String
|
|
}
|
|
|
|
<span class="attr">#[actix_web::test]
|
|
</span><span class="kw">async fn </span>test_add_person() {
|
|
<span class="kw">let </span>app = test::init_service(
|
|
App::new().service(
|
|
web::resource(<span class="string">"/people"</span>)
|
|
.route(web::post().to(|person: web::Json<Person>| <span class="kw">async </span>{
|
|
HttpResponse::Ok()
|
|
.json(person)})
|
|
))
|
|
).<span class="kw">await</span>;
|
|
|
|
<span class="kw">let </span>payload = <span class="string">r#"{"id":"12345","name":"User name"}"#</span>.as_bytes();
|
|
|
|
<span class="kw">let </span>req = test::TestRequest::post()
|
|
.uri(<span class="string">"/people"</span>)
|
|
.header(header::CONTENT_TYPE, <span class="string">"application/json"</span>)
|
|
.set_payload(payload)
|
|
.to_request();
|
|
|
|
<span class="kw">let </span>result: Person = test::call_and_read_body_json(<span class="kw-2">&mut </span>app, req).<span class="kw">await</span>;
|
|
}</code></pre></div>
|
|
<h2 id="panics"><a class="doc-anchor" href="#panics">§</a>Panics</h2>
|
|
<p>Panics if:</p>
|
|
<ul>
|
|
<li>service call returns an error body yields an error while it is being read;</li>
|
|
<li>body yields an error while it is being read;</li>
|
|
<li>received body is not a valid JSON representation of <code>T</code>.</li>
|
|
</ul>
|
|
</div></details></section></div></main></body></html> |