mirror of
https://github.com/fafhrd91/actix-web
synced 2024-11-24 00:21:08 +01:00
8 lines
8.7 KiB
HTML
8 lines
8.7 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="Interface for routing guards."><title>Guard in actix_web::guard - 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_web" 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 trait"><!--[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_web/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_web/index.html"><img src="https://actix.rs/img/logo.png" alt="logo"></a><h2><a href="../../actix_web/index.html">actix_web</a><span class="version">4.6.0</span></h2></div><h2 class="location"><a href="#">Guard</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.check">check</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-Guard-for-Rc%3Cdyn+Guard%3E">Rc<dyn Guard></a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In actix_web::guard</a></h2></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>Trait <a href="../index.html">actix_web</a>::<wbr><a href="index.html">guard</a>::<wbr><a class="trait" href="#">Guard</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/actix_web/guard/mod.rs.html#118-121">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait Guard {
|
|
// Required method
|
|
fn <a href="#tymethod.check" class="fn">check</a>(&self, ctx: &<a class="struct" href="struct.GuardContext.html" title="struct actix_web::guard::GuardContext">GuardContext</a><'_>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>;
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Interface for routing guards.</p>
|
|
<p>See <a href="index.html" title="mod actix_web::guard">module level documentation</a> for more.</p>
|
|
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.check" class="method"><a class="src rightside" href="../../src/actix_web/guard/mod.rs.html#120">source</a><h4 class="code-header">fn <a href="#tymethod.check" class="fn">check</a>(&self, ctx: &<a class="struct" href="struct.GuardContext.html" title="struct actix_web::guard::GuardContext">GuardContext</a><'_>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns true if predicate condition is met for a given request.</p>
|
|
</div></details></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-Guard-for-Rc%3Cdyn+Guard%3E" class="impl"><a class="src rightside" href="../../src/actix_web/guard/mod.rs.html#123-127">source</a><a href="#impl-Guard-for-Rc%3Cdyn+Guard%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Guard.html" title="trait actix_web::guard::Guard">Guard</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a><dyn <a class="trait" href="trait.Guard.html" title="trait actix_web::guard::Guard">Guard</a>></h3></section></summary><div class="impl-items"><section id="method.check" class="method trait-impl"><a class="src rightside" href="../../src/actix_web/guard/mod.rs.html#124-126">source</a><a href="#method.check" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.check" class="fn">check</a>(&self, ctx: &<a class="struct" href="struct.GuardContext.html" title="struct actix_web::guard::GuardContext">GuardContext</a><'_>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-Guard-for-Acceptable" class="impl"><a class="src rightside" href="../../src/actix_web/guard/acceptable.rs.html#45-66">source</a><a href="#impl-Guard-for-Acceptable" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Guard.html" title="trait actix_web::guard::Guard">Guard</a> for <a class="struct" href="struct.Acceptable.html" title="struct actix_web::guard::Acceptable">Acceptable</a></h3></section><section id="impl-Guard-for-AllGuard" class="impl"><a class="src rightside" href="../../src/actix_web/guard/mod.rs.html#257-268">source</a><a href="#impl-Guard-for-AllGuard" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Guard.html" title="trait actix_web::guard::Guard">Guard</a> for <a class="struct" href="struct.AllGuard.html" title="struct actix_web::guard::AllGuard">AllGuard</a></h3></section><section id="impl-Guard-for-AnyGuard" class="impl"><a class="src rightside" href="../../src/actix_web/guard/mod.rs.html#205-216">source</a><a href="#impl-Guard-for-AnyGuard" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Guard.html" title="trait actix_web::guard::Guard">Guard</a> for <a class="struct" href="struct.AnyGuard.html" title="struct actix_web::guard::AnyGuard">AnyGuard</a></h3></section><section id="impl-Guard-for-F" class="impl"><a class="src rightside" href="../../src/actix_web/guard/mod.rs.html#159-166">source</a><a href="#impl-Guard-for-F" class="anchor">§</a><h3 class="code-header">impl<F> <a class="trait" href="trait.Guard.html" title="trait actix_web::guard::Guard">Guard</a> for F<div class="where">where
|
|
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>(&<a class="struct" href="struct.GuardContext.html" title="struct actix_web::guard::GuardContext">GuardContext</a><'_>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>,</div></h3></section><section id="impl-Guard-for-Not%3CG%3E" class="impl"><a class="src rightside" href="../../src/actix_web/guard/mod.rs.html#283-288">source</a><a href="#impl-Guard-for-Not%3CG%3E" class="anchor">§</a><h3 class="code-header">impl<G: <a class="trait" href="trait.Guard.html" title="trait actix_web::guard::Guard">Guard</a>> <a class="trait" href="trait.Guard.html" title="trait actix_web::guard::Guard">Guard</a> for <a class="struct" href="struct.Not.html" title="struct actix_web::guard::Not">Not</a><G></h3></section></div><script src="../../trait.impl/actix_web/guard/trait.Guard.js" data-ignore-extern-crates="alloc" async></script></section></div></main></body></html> |