10 lines
4.9 KiB
HTML
10 lines
4.9 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="Proxy matchers"><title>hyper_util::client::proxy::matcher - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../../" data-static-root-path="../../../../static.files/" data-current-crate="hyper_util" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../../../static.files/storage-e2aeef58.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">Module matcher</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../../hyper_util/index.html">hyper_<wbr>util</a><span class="version">0.1.20</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module matcher</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In hyper_<wbr>util::<wbr>client::<wbr>proxy</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../../index.html">hyper_util</a>::<wbr><a href="../../index.html">client</a>::<wbr><a href="../index.html">proxy</a></div><h1>Module <span>matcher</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../../../src/hyper_util/client/proxy/matcher.rs.html#1-929">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Proxy matchers</p>
|
|
<p>This module contains different matchers to configure rules for when a proxy
|
|
should be used, and if so, with what arguments.</p>
|
|
<p>A <a href="struct.Matcher.html" title="struct hyper_util::client::proxy::matcher::Matcher"><code>Matcher</code></a> can be constructed either using environment variables, or
|
|
a <a href="struct.Matcher.html#method.builder" title="associated function hyper_util::client::proxy::matcher::Matcher::builder"><code>Matcher::builder()</code></a>.</p>
|
|
<p>Once constructed, the <code>Matcher</code> can be asked if it intercepts a <code>Uri</code> by
|
|
calling <a href="struct.Matcher.html#method.intercept" title="method hyper_util::client::proxy::matcher::Matcher::intercept"><code>Matcher::intercept()</code></a>.</p>
|
|
<p>An <a href="struct.Intercept.html" title="struct hyper_util::client::proxy::matcher::Intercept"><code>Intercept</code></a> includes the destination for the proxy, and any parsed
|
|
authentication to be used.</p>
|
|
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.Builder.html" title="struct hyper_util::client::proxy::matcher::Builder">Builder</a></dt><dd>A builder to create a <a href="struct.Matcher.html" title="struct hyper_util::client::proxy::matcher::Matcher"><code>Matcher</code></a>.</dd><dt><a class="struct" href="struct.Intercept.html" title="struct hyper_util::client::proxy::matcher::Intercept">Intercept</a></dt><dd>A matched proxy,</dd><dt><a class="struct" href="struct.Matcher.html" title="struct hyper_util::client::proxy::matcher::Matcher">Matcher</a></dt><dd>A proxy matcher, usually built from environment variables.</dd></dl></section></div></main></body></html> |