124 lines
11 KiB
HTML
124 lines
11 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="Source of the Rust file `C:\Users\szend\.cargo\registry\src\index.crates.io-1949cf8c6b5b557f\matchit-0.7.3\src\lib.rs`."><title>lib.rs - source</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="matchit" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11)" 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="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.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 src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">matchit/</div>lib.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="doccomment">//! # `matchit`
|
|
<a href=#2 id=2 data-nosnippet>2</a>//!
|
|
<a href=#3 id=3 data-nosnippet>3</a>//! [](https://docs.rs/matchit)
|
|
<a href=#4 id=4 data-nosnippet>4</a>//! [](https://crates.io/crates/matchit)
|
|
<a href=#5 id=5 data-nosnippet>5</a>//! [](https://crates.io/crates/matchit)
|
|
<a href=#6 id=6 data-nosnippet>6</a>//!
|
|
<a href=#7 id=7 data-nosnippet>7</a>//! A blazing fast URL router.
|
|
<a href=#8 id=8 data-nosnippet>8</a>//!
|
|
<a href=#9 id=9 data-nosnippet>9</a>//! ```rust
|
|
<a href=#10 id=10 data-nosnippet>10</a>//! use matchit::Router;
|
|
<a href=#11 id=11 data-nosnippet>11</a>//!
|
|
<a href=#12 id=12 data-nosnippet>12</a>//! # fn main() -> Result<(), Box<dyn std::error::Error>> {
|
|
<a href=#13 id=13 data-nosnippet>13</a>//! let mut router = Router::new();
|
|
<a href=#14 id=14 data-nosnippet>14</a>//! router.insert("/home", "Welcome!")?;
|
|
<a href=#15 id=15 data-nosnippet>15</a>//! router.insert("/users/:id", "A User")?;
|
|
<a href=#16 id=16 data-nosnippet>16</a>//!
|
|
<a href=#17 id=17 data-nosnippet>17</a>//! let matched = router.at("/users/978")?;
|
|
<a href=#18 id=18 data-nosnippet>18</a>//! assert_eq!(matched.params.get("id"), Some("978"));
|
|
<a href=#19 id=19 data-nosnippet>19</a>//! assert_eq!(*matched.value, "A User");
|
|
<a href=#20 id=20 data-nosnippet>20</a>//! # Ok(())
|
|
<a href=#21 id=21 data-nosnippet>21</a>//! # }
|
|
<a href=#22 id=22 data-nosnippet>22</a>//! ```
|
|
<a href=#23 id=23 data-nosnippet>23</a>//!
|
|
<a href=#24 id=24 data-nosnippet>24</a>//! ## Parameters
|
|
<a href=#25 id=25 data-nosnippet>25</a>//!
|
|
<a href=#26 id=26 data-nosnippet>26</a>//! Along with static routes, the router also supports dynamic route segments. These can either be named or catch-all parameters:
|
|
<a href=#27 id=27 data-nosnippet>27</a>//!
|
|
<a href=#28 id=28 data-nosnippet>28</a>//! ### Named Parameters
|
|
<a href=#29 id=29 data-nosnippet>29</a>//!
|
|
<a href=#30 id=30 data-nosnippet>30</a>//! Named parameters like `/:id` match anything until the next `/` or the end of the path:
|
|
<a href=#31 id=31 data-nosnippet>31</a>//!
|
|
<a href=#32 id=32 data-nosnippet>32</a>//! ```rust
|
|
<a href=#33 id=33 data-nosnippet>33</a>//! # use matchit::Router;
|
|
<a href=#34 id=34 data-nosnippet>34</a>//! # fn main() -> Result<(), Box<dyn std::error::Error>> {
|
|
<a href=#35 id=35 data-nosnippet>35</a>//! let mut m = Router::new();
|
|
<a href=#36 id=36 data-nosnippet>36</a>//! m.insert("/users/:id", true)?;
|
|
<a href=#37 id=37 data-nosnippet>37</a>//!
|
|
<a href=#38 id=38 data-nosnippet>38</a>//! assert_eq!(m.at("/users/1")?.params.get("id"), Some("1"));
|
|
<a href=#39 id=39 data-nosnippet>39</a>//! assert_eq!(m.at("/users/23")?.params.get("id"), Some("23"));
|
|
<a href=#40 id=40 data-nosnippet>40</a>//! assert!(m.at("/users").is_err());
|
|
<a href=#41 id=41 data-nosnippet>41</a>//!
|
|
<a href=#42 id=42 data-nosnippet>42</a>//! # Ok(())
|
|
<a href=#43 id=43 data-nosnippet>43</a>//! # }
|
|
<a href=#44 id=44 data-nosnippet>44</a>//! ```
|
|
<a href=#45 id=45 data-nosnippet>45</a>//!
|
|
<a href=#46 id=46 data-nosnippet>46</a>//! ### Catch-all Parameters
|
|
<a href=#47 id=47 data-nosnippet>47</a>//!
|
|
<a href=#48 id=48 data-nosnippet>48</a>//! Catch-all parameters start with `*` and match everything after the `/`. They must always be at the **end** of the route:
|
|
<a href=#49 id=49 data-nosnippet>49</a>//!
|
|
<a href=#50 id=50 data-nosnippet>50</a>//! ```rust
|
|
<a href=#51 id=51 data-nosnippet>51</a>//! # use matchit::Router;
|
|
<a href=#52 id=52 data-nosnippet>52</a>//! # fn main() -> Result<(), Box<dyn std::error::Error>> {
|
|
<a href=#53 id=53 data-nosnippet>53</a>//! let mut m = Router::new();
|
|
<a href=#54 id=54 data-nosnippet>54</a>//! m.insert("/*p", true)?;
|
|
<a href=#55 id=55 data-nosnippet>55</a>//!
|
|
<a href=#56 id=56 data-nosnippet>56</a>//! assert_eq!(m.at("/foo.js")?.params.get("p"), Some("foo.js"));
|
|
<a href=#57 id=57 data-nosnippet>57</a>//! assert_eq!(m.at("/c/bar.css")?.params.get("p"), Some("c/bar.css"));
|
|
<a href=#58 id=58 data-nosnippet>58</a>//!
|
|
<a href=#59 id=59 data-nosnippet>59</a>//! // note that this would not match
|
|
<a href=#60 id=60 data-nosnippet>60</a>//! assert!(m.at("/").is_err());
|
|
<a href=#61 id=61 data-nosnippet>61</a>//!
|
|
<a href=#62 id=62 data-nosnippet>62</a>//! # Ok(())
|
|
<a href=#63 id=63 data-nosnippet>63</a>//! # }
|
|
<a href=#64 id=64 data-nosnippet>64</a>//! ```
|
|
<a href=#65 id=65 data-nosnippet>65</a>//!
|
|
<a href=#66 id=66 data-nosnippet>66</a>//! ## Routing Priority
|
|
<a href=#67 id=67 data-nosnippet>67</a>//!
|
|
<a href=#68 id=68 data-nosnippet>68</a>//! Static and dynamic route segments are allowed to overlap. If they do, static segments will be given higher priority:
|
|
<a href=#69 id=69 data-nosnippet>69</a>//!
|
|
<a href=#70 id=70 data-nosnippet>70</a>//! ```rust
|
|
<a href=#71 id=71 data-nosnippet>71</a>//! # use matchit::Router;
|
|
<a href=#72 id=72 data-nosnippet>72</a>//! # fn main() -> Result<(), Box<dyn std::error::Error>> {
|
|
<a href=#73 id=73 data-nosnippet>73</a>//! let mut m = Router::new();
|
|
<a href=#74 id=74 data-nosnippet>74</a>//! m.insert("/", "Welcome!").unwrap() ; // priority: 1
|
|
<a href=#75 id=75 data-nosnippet>75</a>//! m.insert("/about", "About Me").unwrap(); // priority: 1
|
|
<a href=#76 id=76 data-nosnippet>76</a>//! m.insert("/*filepath", "...").unwrap(); // priority: 2
|
|
<a href=#77 id=77 data-nosnippet>77</a>//!
|
|
<a href=#78 id=78 data-nosnippet>78</a>//! # Ok(())
|
|
<a href=#79 id=79 data-nosnippet>79</a>//! # }
|
|
<a href=#80 id=80 data-nosnippet>80</a>//! ```
|
|
<a href=#81 id=81 data-nosnippet>81</a>//!
|
|
<a href=#82 id=82 data-nosnippet>82</a>//! ## How does it work?
|
|
<a href=#83 id=83 data-nosnippet>83</a>//!
|
|
<a href=#84 id=84 data-nosnippet>84</a>//! The router takes advantage of the fact that URL routes generally follow a hierarchical structure. Routes are stored them in a radix trie that makes heavy use of common prefixes:
|
|
<a href=#85 id=85 data-nosnippet>85</a>//!
|
|
<a href=#86 id=86 data-nosnippet>86</a>//! ```text
|
|
<a href=#87 id=87 data-nosnippet>87</a>//! Priority Path Value
|
|
<a href=#88 id=88 data-nosnippet>88</a>//! 9 \ 1
|
|
<a href=#89 id=89 data-nosnippet>89</a>//! 3 ├s None
|
|
<a href=#90 id=90 data-nosnippet>90</a>//! 2 |├earch\ 2
|
|
<a href=#91 id=91 data-nosnippet>91</a>//! 1 |└upport\ 3
|
|
<a href=#92 id=92 data-nosnippet>92</a>//! 2 ├blog\ 4
|
|
<a href=#93 id=93 data-nosnippet>93</a>//! 1 | └:post None
|
|
<a href=#94 id=94 data-nosnippet>94</a>//! 1 | └\ 5
|
|
<a href=#95 id=95 data-nosnippet>95</a>//! 2 ├about-us\ 6
|
|
<a href=#96 id=96 data-nosnippet>96</a>//! 1 | └team\ 7
|
|
<a href=#97 id=97 data-nosnippet>97</a>//! 1 └contact\ 8
|
|
<a href=#98 id=98 data-nosnippet>98</a>//! ```
|
|
<a href=#99 id=99 data-nosnippet>99</a>//!
|
|
<a href=#100 id=100 data-nosnippet>100</a>//! This allows us to reduce the route search to a small number of branches. Child nodes on the same level of the tree are also prioritized
|
|
<a href=#101 id=101 data-nosnippet>101</a>//! by the number of children with registered values, increasing the chance of choosing the correct branch of the first try.
|
|
<a href=#102 id=102 data-nosnippet>102</a></span><span class="attr">#![deny(rust_2018_idioms, clippy::all)]
|
|
<a href=#103 id=103 data-nosnippet>103</a>
|
|
<a href=#104 id=104 data-nosnippet>104</a></span><span class="kw">mod </span>error;
|
|
<a href=#105 id=105 data-nosnippet>105</a><span class="kw">mod </span>params;
|
|
<a href=#106 id=106 data-nosnippet>106</a><span class="kw">mod </span>router;
|
|
<a href=#107 id=107 data-nosnippet>107</a><span class="kw">mod </span>tree;
|
|
<a href=#108 id=108 data-nosnippet>108</a>
|
|
<a href=#109 id=109 data-nosnippet>109</a><span class="kw">pub use </span>error::{InsertError, MatchError};
|
|
<a href=#110 id=110 data-nosnippet>110</a><span class="kw">pub use </span>params::{Params, ParamsIter};
|
|
<a href=#111 id=111 data-nosnippet>111</a><span class="kw">pub use </span>router::{Match, Router};
|
|
<a href=#112 id=112 data-nosnippet>112</a>
|
|
<a href=#113 id=113 data-nosnippet>113</a><span class="attr">#[cfg(doctest)]
|
|
<a href=#114 id=114 data-nosnippet>114</a></span><span class="kw">mod </span>test_readme {
|
|
<a href=#115 id=115 data-nosnippet>115</a> <span class="macro">macro_rules!</span> doc_comment {
|
|
<a href=#116 id=116 data-nosnippet>116</a> (<span class="macro-nonterminal">$x</span>:expr) => {
|
|
<a href=#117 id=117 data-nosnippet>117</a> <span class="attr">#[doc = <span class="macro-nonterminal">$x</span>]
|
|
<a href=#118 id=118 data-nosnippet>118</a> </span><span class="kw">extern </span><span class="string">"C" </span>{}
|
|
<a href=#119 id=119 data-nosnippet>119</a> };
|
|
<a href=#120 id=120 data-nosnippet>120</a> }
|
|
<a href=#121 id=121 data-nosnippet>121</a>
|
|
<a href=#122 id=122 data-nosnippet>122</a> <span class="macro">doc_comment!</span>(<span class="macro">include_str!</span>(<span class="string">"../README.md"</span>));
|
|
<a href=#123 id=123 data-nosnippet>123</a>}
|
|
</code></pre></div></section></main></body></html> |