mirror of
https://github.com/actix/actix-website
synced 2024-11-25 01:02:58 +01:00
153 lines
12 KiB
HTML
153 lines
12 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 `pred` mod in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, pred"><title>actix_web::pred - 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 mod"><!--[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'>Module pred</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../index.html'>actix_web</a></p><script>window.sidebarCurrent = {name: 'pred', ty: 'mod', 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'>Module <a href='../index.html'>actix_web</a>::<wbr><a class="mod" href=''>pred</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/pred.rs.html#1-329' title='goto source code'>[src]</a></span></h1><div class='docblock'><p>Route match predicates</p>
|
|||
|
|
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.AllPredicate.html"
|
|||
|
|
title='struct actix_web::pred::AllPredicate'>AllPredicate</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Matches if all of supplied predicate matches.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.AnyPredicate.html"
|
|||
|
|
title='struct actix_web::pred::AnyPredicate'>AnyPredicate</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Matches if any of supplied predicate matches.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="trait" href="trait.Predicate.html"
|
|||
|
|
title='trait actix_web::pred::Predicate'>Predicate</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Trait defines resource route predicate.
|
|||
|
|
Predicate can modify request object. It is also possible to
|
|||
|
|
to store extra attributes on request by using <code>Extensions</code> container,
|
|||
|
|
Extensions container available via <code>HttpRequest::extensions()</code> method.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="fn" href="fn.All.html"
|
|||
|
|
title='fn actix_web::pred::All'>All</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Return predicate that matches if all of supplied predicate matches.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="fn" href="fn.Any.html"
|
|||
|
|
title='fn actix_web::pred::Any'>Any</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Return predicate that matches if any of supplied predicate matches.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="fn" href="fn.Connect.html"
|
|||
|
|
title='fn actix_web::pred::Connect'>Connect</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Predicate to match <em>CONNECT</em> http method</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="fn" href="fn.Delete.html"
|
|||
|
|
title='fn actix_web::pred::Delete'>Delete</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Predicate to match <em>DELETE</em> http method</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="fn" href="fn.Get.html"
|
|||
|
|
title='fn actix_web::pred::Get'>Get</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Predicate to match <em>GET</em> http method</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="fn" href="fn.Head.html"
|
|||
|
|
title='fn actix_web::pred::Head'>Head</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Predicate to match <em>HEAD</em> http method</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="fn" href="fn.Header.html"
|
|||
|
|
title='fn actix_web::pred::Header'>Header</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Return predicate that matches if request contains specified header and
|
|||
|
|
value.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="fn" href="fn.Host.html"
|
|||
|
|
title='fn actix_web::pred::Host'>Host</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Return predicate that matches if request contains specified Host name.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="fn" href="fn.Method.html"
|
|||
|
|
title='fn actix_web::pred::Method'>Method</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Predicate to match specified http method</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="fn" href="fn.Not.html"
|
|||
|
|
title='fn actix_web::pred::Not'>Not</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Return predicate that matches if supplied predicate does not match.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="fn" href="fn.Options.html"
|
|||
|
|
title='fn actix_web::pred::Options'>Options</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Predicate to match <em>OPTIONS</em> http method</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="fn" href="fn.Patch.html"
|
|||
|
|
title='fn actix_web::pred::Patch'>Patch</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Predicate to match <em>PATCH</em> http method</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="fn" href="fn.Post.html"
|
|||
|
|
title='fn actix_web::pred::Post'>Post</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Predicate to match <em>POST</em> http method</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="fn" href="fn.Put.html"
|
|||
|
|
title='fn actix_web::pred::Put'>Put</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Predicate to match <em>PUT</em> http method</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="fn" href="fn.Trace.html"
|
|||
|
|
title='fn actix_web::pred::Trace'>Trace</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Predicate to match <em>TRACE</em> http method</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr></table></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>
|