<!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 `/Users/m018/.cargo/registry/src/github.com-1ecc6299db9ec823/phf-0.11.2/src/set.rs`."><title>set.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-c4dbdcde0fbd8430.css" id="mainThemeStyle"><link rel="stylesheet" id="themeStyle" href="../../static.files/light-db279b6232be9c13.css"><link rel="stylesheet" disabled href="../../static.files/dark-cf923f49f397b216.css"><link rel="stylesheet" disabled href="../../static.files/ayu-be46fdc453a55015.css"><script src="../../static.files/storage-3891ce972e3a2bf8.js"></script><script defer src="../../static.files/source-script-1b95b7cca98b26e5.js"></script><script defer src="../../source-files.js"></script><script defer src="../../static.files/main-98a684e84ae5b08b.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-13285aec31fa243e.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"></nav><main><nav class="sub"><a class="sub-logo-container" href="../../phf/index.html"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><a href="#1" id="1">1</a>
<a href="#2" id="2">2</a>
<a href="#3" id="3">3</a>
<a href="#4" id="4">4</a>
<a href="#5" id="5">5</a>
<a href="#6" id="6">6</a>
<a href="#7" id="7">7</a>
<a href="#8" id="8">8</a>
<a href="#9" id="9">9</a>
<a href="#10" id="10">10</a>
<a href="#11" id="11">11</a>
<a href="#12" id="12">12</a>
<a href="#13" id="13">13</a>
<a href="#14" id="14">14</a>
<a href="#15" id="15">15</a>
<a href="#16" id="16">16</a>
<a href="#17" id="17">17</a>
<a href="#18" id="18">18</a>
<a href="#19" id="19">19</a>
<a href="#20" id="20">20</a>
<a href="#21" id="21">21</a>
<a href="#22" id="22">22</a>
<a href="#23" id="23">23</a>
<a href="#24" id="24">24</a>
<a href="#25" id="25">25</a>
<a href="#26" id="26">26</a>
<a href="#27" id="27">27</a>
<a href="#28" id="28">28</a>
<a href="#29" id="29">29</a>
<a href="#30" id="30">30</a>
<a href="#31" id="31">31</a>
<a href="#32" id="32">32</a>
<a href="#33" id="33">33</a>
<a href="#34" id="34">34</a>
<a href="#35" id="35">35</a>
<a href="#36" id="36">36</a>
<a href="#37" id="37">37</a>
<a href="#38" id="38">38</a>
<a href="#39" id="39">39</a>
<a href="#40" id="40">40</a>
<a href="#41" id="41">41</a>
<a href="#42" id="42">42</a>
<a href="#43" id="43">43</a>
<a href="#44" id="44">44</a>
<a href="#45" id="45">45</a>
<a href="#46" id="46">46</a>
<a href="#47" id="47">47</a>
<a href="#48" id="48">48</a>
<a href="#49" id="49">49</a>
<a href="#50" id="50">50</a>
<a href="#51" id="51">51</a>
<a href="#52" id="52">52</a>
<a href="#53" id="53">53</a>
<a href="#54" id="54">54</a>
<a href="#55" id="55">55</a>
<a href="#56" id="56">56</a>
<a href="#57" id="57">57</a>
<a href="#58" id="58">58</a>
<a href="#59" id="59">59</a>
<a href="#60" id="60">60</a>
<a href="#61" id="61">61</a>
<a href="#62" id="62">62</a>
<a href="#63" id="63">63</a>
<a href="#64" id="64">64</a>
<a href="#65" id="65">65</a>
<a href="#66" id="66">66</a>
<a href="#67" id="67">67</a>
<a href="#68" id="68">68</a>
<a href="#69" id="69">69</a>
<a href="#70" id="70">70</a>
<a href="#71" id="71">71</a>
<a href="#72" id="72">72</a>
<a href="#73" id="73">73</a>
<a href="#74" id="74">74</a>
<a href="#75" id="75">75</a>
<a href="#76" id="76">76</a>
<a href="#77" id="77">77</a>
<a href="#78" id="78">78</a>
<a href="#79" id="79">79</a>
<a href="#80" id="80">80</a>
<a href="#81" id="81">81</a>
<a href="#82" id="82">82</a>
<a href="#83" id="83">83</a>
<a href="#84" id="84">84</a>
<a href="#85" id="85">85</a>
<a href="#86" id="86">86</a>
<a href="#87" id="87">87</a>
<a href="#88" id="88">88</a>
<a href="#89" id="89">89</a>
<a href="#90" id="90">90</a>
<a href="#91" id="91">91</a>
<a href="#92" id="92">92</a>
<a href="#93" id="93">93</a>
<a href="#94" id="94">94</a>
<a href="#95" id="95">95</a>
<a href="#96" id="96">96</a>
<a href="#97" id="97">97</a>
<a href="#98" id="98">98</a>
<a href="#99" id="99">99</a>
<a href="#100" id="100">100</a>
<a href="#101" id="101">101</a>
<a href="#102" id="102">102</a>
<a href="#103" id="103">103</a>
<a href="#104" id="104">104</a>
<a href="#105" id="105">105</a>
<a href="#106" id="106">106</a>
<a href="#107" id="107">107</a>
<a href="#108" id="108">108</a>
<a href="#109" id="109">109</a>
<a href="#110" id="110">110</a>
<a href="#111" id="111">111</a>
<a href="#112" id="112">112</a>
<a href="#113" id="113">113</a>
<a href="#114" id="114">114</a>
<a href="#115" id="115">115</a>
<a href="#116" id="116">116</a>
<a href="#117" id="117">117</a>
<a href="#118" id="118">118</a>
<a href="#119" id="119">119</a>
<a href="#120" id="120">120</a>
<a href="#121" id="121">121</a>
<a href="#122" id="122">122</a>
<a href="#123" id="123">123</a>
<a href="#124" id="124">124</a>
<a href="#125" id="125">125</a>
<a href="#126" id="126">126</a>
<a href="#127" id="127">127</a>
<a href="#128" id="128">128</a>
<a href="#129" id="129">129</a>
<a href="#130" id="130">130</a>
<a href="#131" id="131">131</a>
<a href="#132" id="132">132</a>
<a href="#133" id="133">133</a>
<a href="#134" id="134">134</a>
<a href="#135" id="135">135</a>
<a href="#136" id="136">136</a>
<a href="#137" id="137">137</a>
<a href="#138" id="138">138</a>
<a href="#139" id="139">139</a>
<a href="#140" id="140">140</a>
<a href="#141" id="141">141</a>
<a href="#142" id="142">142</a>
<a href="#143" id="143">143</a>
<a href="#144" id="144">144</a>
<a href="#145" id="145">145</a>
<a href="#146" id="146">146</a>
<a href="#147" id="147">147</a>
</pre><pre class="rust"><code><span class="doccomment">//! An immutable set constructed at compile time.
</span><span class="kw">use </span>core::fmt;
<span class="kw">use </span>core::iter::FusedIterator;
<span class="kw">use </span>core::iter::IntoIterator;
<span class="kw">use </span>phf_shared::{PhfBorrow, PhfHash};
<span class="kw">use crate</span>::{map, Map};
<span class="doccomment">/// An immutable set constructed at compile time.
///
/// ## Note
///
/// The fields of this struct are public so that they may be initialized by the
/// `phf_set!` macro and code generation. They are subject to change at any
/// time and should never be accessed directly.
</span><span class="kw">pub struct </span>Set<T: <span class="lifetime">'static</span>> {
<span class="attr">#[doc(hidden)]
</span><span class="kw">pub </span>map: Map<T, ()>,
}
<span class="kw">impl</span><T> fmt::Debug <span class="kw">for </span>Set<T>
<span class="kw">where
</span>T: fmt::Debug,
{
<span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, fmt: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result {
fmt.debug_set().entries(<span class="self">self</span>).finish()
}
}
<span class="kw">impl</span><T> Set<T> {
<span class="doccomment">/// Returns the number of elements in the `Set`.
</span><span class="attr">#[inline]
</span><span class="kw">pub const fn </span>len(<span class="kw-2">&</span><span class="self">self</span>) -> usize {
<span class="self">self</span>.map.len()
}
<span class="doccomment">/// Returns true if the `Set` contains no elements.
</span><span class="attr">#[inline]
</span><span class="kw">pub const fn </span>is_empty(<span class="kw-2">&</span><span class="self">self</span>) -> bool {
<span class="self">self</span>.len() == <span class="number">0
</span>}
<span class="doccomment">/// Returns a reference to the set's internal static instance of the given
/// key.
///
/// This can be useful for interning schemes.
</span><span class="kw">pub fn </span>get_key<U: <span class="question-mark">?</span>Sized>(<span class="kw-2">&</span><span class="self">self</span>, key: <span class="kw-2">&</span>U) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>T>
<span class="kw">where
</span>U: Eq + PhfHash,
T: PhfBorrow<U>,
{
<span class="self">self</span>.map.get_key(key)
}
<span class="doccomment">/// Returns true if `value` is in the `Set`.
</span><span class="kw">pub fn </span>contains<U: <span class="question-mark">?</span>Sized>(<span class="kw-2">&</span><span class="self">self</span>, value: <span class="kw-2">&</span>U) -> bool
<span class="kw">where
</span>U: Eq + PhfHash,
T: PhfBorrow<U>,
{
<span class="self">self</span>.map.contains_key(value)
}
<span class="doccomment">/// Returns an iterator over the values in the set.
///
/// Values are returned in an arbitrary but fixed order.
</span><span class="kw">pub fn </span>iter(<span class="kw-2">&</span><span class="self">self</span>) -> Iter<<span class="lifetime">'_</span>, T> {
Iter {
iter: <span class="self">self</span>.map.keys(),
}
}
}
<span class="kw">impl</span><T> Set<T>
<span class="kw">where
</span>T: Eq + PhfHash + PhfBorrow<T>,
{
<span class="doccomment">/// Returns true if `other` shares no elements with `self`.
</span><span class="kw">pub fn </span>is_disjoint(<span class="kw-2">&</span><span class="self">self</span>, other: <span class="kw-2">&</span>Set<T>) -> bool {
!<span class="self">self</span>.iter().any(|value| other.contains(value))
}
<span class="doccomment">/// Returns true if `other` contains all values in `self`.
</span><span class="kw">pub fn </span>is_subset(<span class="kw-2">&</span><span class="self">self</span>, other: <span class="kw-2">&</span>Set<T>) -> bool {
<span class="self">self</span>.iter().all(|value| other.contains(value))
}
<span class="doccomment">/// Returns true if `self` contains all values in `other`.
</span><span class="kw">pub fn </span>is_superset(<span class="kw-2">&</span><span class="self">self</span>, other: <span class="kw-2">&</span>Set<T>) -> bool {
other.is_subset(<span class="self">self</span>)
}
}
<span class="kw">impl</span><<span class="lifetime">'a</span>, T> IntoIterator <span class="kw">for </span><span class="kw-2">&</span><span class="lifetime">'a </span>Set<T> {
<span class="kw">type </span>Item = <span class="kw-2">&</span><span class="lifetime">'a </span>T;
<span class="kw">type </span>IntoIter = Iter<<span class="lifetime">'a</span>, T>;
<span class="kw">fn </span>into_iter(<span class="self">self</span>) -> Iter<<span class="lifetime">'a</span>, T> {
<span class="self">self</span>.iter()
}
}
<span class="doccomment">/// An iterator over the values in a `Set`.
</span><span class="kw">pub struct </span>Iter<<span class="lifetime">'a</span>, T: <span class="lifetime">'static</span>> {
iter: map::Keys<<span class="lifetime">'a</span>, T, ()>,
}
<span class="kw">impl</span><<span class="lifetime">'a</span>, T> Clone <span class="kw">for </span>Iter<<span class="lifetime">'a</span>, T> {
<span class="attr">#[inline]
</span><span class="kw">fn </span>clone(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="self">Self </span>{
<span class="self">Self </span>{
iter: <span class="self">self</span>.iter.clone(),
}
}
}
<span class="kw">impl</span><<span class="lifetime">'a</span>, T> fmt::Debug <span class="kw">for </span>Iter<<span class="lifetime">'a</span>, T>
<span class="kw">where
</span>T: fmt::Debug,
{
<span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter) -> fmt::Result {
f.debug_list().entries(<span class="self">self</span>.clone()).finish()
}
}
<span class="kw">impl</span><<span class="lifetime">'a</span>, T> Iterator <span class="kw">for </span>Iter<<span class="lifetime">'a</span>, T> {
<span class="kw">type </span>Item = <span class="kw-2">&</span><span class="lifetime">'a </span>T;
<span class="kw">fn </span>next(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'a </span>T> {
<span class="self">self</span>.iter.next()
}
<span class="kw">fn </span>size_hint(<span class="kw-2">&</span><span class="self">self</span>) -> (usize, <span class="prelude-ty">Option</span><usize>) {
<span class="self">self</span>.iter.size_hint()
}
}
<span class="kw">impl</span><<span class="lifetime">'a</span>, T> DoubleEndedIterator <span class="kw">for </span>Iter<<span class="lifetime">'a</span>, T> {
<span class="kw">fn </span>next_back(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'a </span>T> {
<span class="self">self</span>.iter.next_back()
}
}
<span class="kw">impl</span><<span class="lifetime">'a</span>, T> ExactSizeIterator <span class="kw">for </span>Iter<<span class="lifetime">'a</span>, T> {}
<span class="kw">impl</span><<span class="lifetime">'a</span>, T> FusedIterator <span class="kw">for </span>Iter<<span class="lifetime">'a</span>, T> {}
</code></pre></div>
</section></main><div id="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="phf" data-themes="" data-resource-suffix="" data-rustdoc-version="1.69.0 (84c898d65 2023-04-16) (built from a source tarball)" data-search-js="search-8a59a8356673ec1f.js" data-settings-js="settings-f0c5c39777a9a2f6.js" data-settings-css="settings-0bcba95ff279c1db.css" ></div></body></html>