mirror of
https://github.com/actix/actix-website
synced 2024-11-24 08:43:01 +01:00
40 lines
15 KiB
HTML
40 lines
15 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 `ResourceInfo` struct in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, ResourceInfo"><title>actix_web::dev::ResourceInfo - 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 ResourceInfo</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.name">name</a><a href="#method.rdef">rdef</a><a href="#method.match_info">match_info</a><a href="#method.url_for">url_for</a><a href="#method.has_resource">has_resource</a><a href="#method.has_prefixed_resource">has_prefixed_resource</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</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'>dev</a></p><script>window.sidebarCurrent = {name: 'ResourceInfo', 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'>dev</a>::<wbr><a class="struct" href=''>ResourceInfo</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/router.rs.html#48-53' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct ResourceInfo { /* fields omitted */ }</pre></div><div class='docblock'><p>Information about current resource</p>
|
||
</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/dev/struct.ResourceInfo.html" title="struct actix_web::dev::ResourceInfo">ResourceInfo</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/router.rs.html#55-160' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.name' class="method"><span id='name.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.name' class='fnname'>name</a>(&self) -> &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/router.rs.html#58-64' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Name os the resource</p>
|
||
</div><h4 id='method.rdef' class="method"><span id='rdef.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.rdef' class='fnname'>rdef</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../../actix_web/dev/struct.ResourceDef.html" title="struct actix_web::dev::ResourceDef">ResourceDef</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/router.rs.html#68-74' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>This method returns reference to matched <code>ResourceDef</code> object.</p>
|
||
</div><h4 id='method.match_info' class="method"><span id='match_info.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.match_info' class='fnname'>match_info</a>(&self) -> &<a class="struct" href="../../actix_web/dev/struct.Params.html" title="struct actix_web::dev::Params">Params</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/router.rs.html#87-89' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Get a reference to the Params object.</p>
|
||
<p>Params is a container for url parameters.
|
||
A variable segment is specified in the form <code>{identifier}</code>,
|
||
where the identifier can be used later in a request handler to
|
||
access the matched value for that segment.</p>
|
||
</div><h4 id='method.url_for' class="method"><span id='url_for.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.url_for' class='fnname'>url_for</a><U, I>(<br> &self, <br> req: &<a class="struct" href="../../actix_web/struct.Request.html" title="struct actix_web::Request">Request</a>, <br> name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> elements: U<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://docs.rs/url/1.7.0/url/struct.Url.html" title="struct url::Url">Url</a>, <a class="enum" href="../../actix_web/error/enum.UrlGenerationError.html" title="enum actix_web::error::UrlGenerationError">UrlGenerationError</a>> <span class="where fmt-newline">where<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 = I>,<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/router.rs.html#107-131' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Generate url for named resource</p>
|
||
<p>Check [<code>HttpRequest::url_for()</code>](../struct.HttpRequest.html#method.
|
||
url_for) for detailed information.</p>
|
||
</div><h4 id='method.has_resource' class="method"><span id='has_resource.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.has_resource' class='fnname'>has_resource</a>(&self, path: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/router.rs.html#139-141' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Check if application contains matching resource.</p>
|
||
<p>This method does not take <code>prefix</code> into account.
|
||
For example if prefix is <code>/test</code> and router contains route <code>/name</code>,
|
||
following path would be recognizable <code>/test/name</code> but <code>has_resource()</code> call
|
||
would return <code>false</code>.</p>
|
||
</div><h4 id='method.has_prefixed_resource' class="method"><span id='has_prefixed_resource.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.has_prefixed_resource' class='fnname'>has_prefixed_resource</a>(&self, path: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/router.rs.html#153-159' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Check if application contains matching resource.</p>
|
||
<p>This method does take <code>prefix</code> into account
|
||
but behaves like <code>has_route</code> in case <code>prefix</code> is not set in the router.</p>
|
||
<p>For example if prefix is <code>/test</code> and router contains route <code>/name</code>, the
|
||
following path would be recognizable <code>/test/name</code> and <code>has_prefixed_route()</code> call
|
||
would return <code>true</code>.
|
||
It will not match against prefix in case it's not given. For example for <code>/name</code>
|
||
with a <code>/test</code> prefix would return <code>false</code></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-Clone' 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/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../../actix_web/dev/struct.ResourceInfo.html" title="struct actix_web::dev::ResourceInfo">ResourceInfo</a></code><a href='#impl-Clone' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/router.rs.html#47' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="struct" href="../../actix_web/dev/struct.ResourceInfo.html" title="struct actix_web::dev::ResourceInfo">ResourceInfo</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/router.rs.html#47' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#130-132' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">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/dev/struct.ResourceInfo.html" title="struct actix_web::dev::ResourceInfo">ResourceInfo</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/dev/struct.ResourceInfo.html" title="struct actix_web::dev::ResourceInfo">ResourceInfo</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> |