2024-08-01 07:04:26 +00:00
<!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 = "Key equivalence trait." > < title > Equivalent in indexmap - 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 = "indexmap" data-themes = "" data-resource-suffix = "" data-rustdoc-version = "1.80.0 (051478957 2024-07-21)" data-channel = "1.80.0" 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 = "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 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 > < / nav > < nav class = "sidebar" > < div class = "sidebar-crate" > < h2 > < a href = "../indexmap/index.html" > indexmap< / a > < span class = "version" > 2.3.0< / span > < / h2 > < / div > < h2 class = "location" > < a href = "#" > Equivalent< / a > < / h2 > < div class = "sidebar-elems" > < section > < h3 > < a href = "#required-methods" > Required Methods< / a > < / h3 > < ul class = "block" > < li > < a href = "#tymethod.equivalent" > equivalent< / a > < / li > < / ul > < h3 > < a href = "#implementors" > Implementors< / a > < / h3 > < / section > < h2 > < a href = "index.html" > In crate indexmap< / 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" > indexmap< / a > ::< wbr > < a class = "trait" href = "#" > Equivalent< / 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/equivalent/lib.rs.html#77" > source< / a > · < button id = "toggle-all-docs" title = "collapse all docs" > [< span > − < / span > ]< / button > < / span > < / div > < pre class = "rust item-decl" > < code > pub trait Equivalent< K> < div class = "where" > where
2024-07-26 09:42:18 +00:00
K: ?< a class = "trait" href = "https://doc.rust-lang.org/1.80.0/core/marker/trait.Sized.html" title = "trait core::marker::Sized" > Sized< / a > ,< / div > {
2024-03-11 08:39:13 +00:00
// Required method
2024-07-26 09:42:18 +00:00
fn < a href = "#tymethod.equivalent" class = "fn" > equivalent< / a > (& self, key: < a class = "primitive" href = "https://doc.rust-lang.org/1.80.0/std/primitive.reference.html" > & K< / a > ) -> < a class = "primitive" href = "https://doc.rust-lang.org/1.80.0/std/primitive.bool.html" > bool< / a > ;
2024-03-11 08:39:13 +00:00
}< / code > < / pre > < details class = "toggle top-doc" open > < summary class = "hideme" > < span > Expand description< / span > < / summary > < div class = "docblock" > < p > Key equivalence trait.< / p >
< p > This trait allows hash table lookup to be customized. It has one blanket
implementation that uses the regular solution with < code > Borrow< / code > and < code > Eq< / code > , just
like < code > HashMap< / code > does, so that you can pass < code > & str< / code > to lookup into a map with
< code > String< / code > keys and so on.< / p >
2024-03-27 11:12:16 +00:00
< h2 id = "contract" > < a class = "doc-anchor" href = "#contract" > §< / a > Contract< / h2 >
2024-03-11 08:39:13 +00:00
< p > The implementor < strong > must< / strong > hash like < code > K< / code > , if it is hashable.< / p >
2024-07-26 09:42:18 +00:00
< / 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.equivalent" class = "method" > < a class = "src rightside" href = "../src/equivalent/lib.rs.html#79" > source< / a > < h4 class = "code-header" > fn < a href = "#tymethod.equivalent" class = "fn" > equivalent< / a > (& self, key: < a class = "primitive" href = "https://doc.rust-lang.org/1.80.0/std/primitive.reference.html" > & K< / a > ) -> < a class = "primitive" href = "https://doc.rust-lang.org/1.80.0/std/primitive.bool.html" > bool< / a > < / h4 > < / section > < / summary > < div class = "docblock" > < p > Compare self to < code > key< / code > and return < code > true< / code > if they are equal.< / p >
2024-03-11 08:39:13 +00:00
< / div > < / details > < / div > < h2 id = "implementors" class = "section-header" > Implementors< a href = "#implementors" class = "anchor" > §< / a > < / h2 > < div id = "implementors-list" > < section id = "impl-Equivalent%3CK%3E-for-Q" class = "impl" > < a class = "src rightside" href = "../src/equivalent/lib.rs.html#82-85" > source< / a > < a href = "#impl-Equivalent%3CK%3E-for-Q" class = "anchor" > §< / a > < h3 class = "code-header" > impl< Q, K> < a class = "trait" href = "trait.Equivalent.html" title = "trait indexmap::Equivalent" > Equivalent< / a > < K> for Q< div class = "where" > where
2024-07-26 09:42:18 +00:00
Q: < a class = "trait" href = "https://doc.rust-lang.org/1.80.0/core/cmp/trait.Eq.html" title = "trait core::cmp::Eq" > Eq< / a > + ?< a class = "trait" href = "https://doc.rust-lang.org/1.80.0/core/marker/trait.Sized.html" title = "trait core::marker::Sized" > Sized< / a > ,
K: < a class = "trait" href = "https://doc.rust-lang.org/1.80.0/core/borrow/trait.Borrow.html" title = "trait core::borrow::Borrow" > Borrow< / a > < Q> + ?< a class = "trait" href = "https://doc.rust-lang.org/1.80.0/core/marker/trait.Sized.html" title = "trait core::marker::Sized" > Sized< / a > ,< / div > < / h3 > < / section > < / div > < script src = "../trait.impl/equivalent/trait.Equivalent.js" async > < / script > < / section > < / div > < / main > < / body > < / html >
