2024-04-09 10:18:33 +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 = "Opt-in mutable access to `IndexMap` keys." > < title > MutableKeys in indexmap::map - Rust< / 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/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2" > < link rel = "stylesheet" href = "../../static.files/normalize-76eba96aa4d2e634.css" > < link rel = "stylesheet" href = "../../static.files/rustdoc-5bc39a1768837dd0.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.77.1 (7cf61ebde 2024-03-27)" data-channel = "1.77.1" data-search-js = "search-dd67cee4cfa65049.js" data-settings-js = "settings-4313503d2e1961c2.js" > < script src = "../../static.files/storage-4c98445ec4002617.js" > < / script > < script defer src = "sidebar-items.js" > < / script > < script defer src = "../../static.files/main-48f368f3872407c8.js" > < / script > < noscript > < link rel = "stylesheet" href = "../../static.files/noscript-04d5337699b92874.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 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.2.6< / span > < / h2 > < / div > < h2 class = "location" > < a href = "#" > MutableKeys< / a > < / h2 > < div class = "sidebar-elems" > < section > < h3 > < a href = "#required-associated-types" > Required Associated Types< / a > < / h3 > < ul class = "block" > < li > < a href = "#associatedtype.Key" > Key< / a > < / li > < li > < a href = "#associatedtype.Value" > Value< / a > < / li > < / ul > < h3 > < a href = "#required-methods" > Required Methods< / a > < / h3 > < ul class = "block" > < li > < a href = "#tymethod.get_full_mut2" > get_full_mut2< / a > < / li > < li > < a href = "#tymethod.get_index_mut2" > get_index_mut2< / a > < / li > < li > < a href = "#tymethod.retain2" > retain2< / a > < / li > < / ul > < h3 > < a href = "#object-safety" > Object Safety< / a > < / h3 > < h3 > < a href = "#implementors" > Implementors< / a > < / h3 > < / section > < h2 > < a href = "index.html" > In indexmap::map< / a > < / h2 > < / div > < / nav > < div class = "sidebar-resizer" > < / div >
2024-03-27 11:50:56 +00:00
< main > < div class = "width-limiter" > < nav class = "sub" > < form class = "search-form" > < span > < / span > < div id = "sidebar-button" tabindex = "-1" > < a href = "../../indexmap/all.html" title = "show sidebar" > < / a > < / div > < input class = "search-input" name = "search" aria-label = "Run search in the documentation" autocomplete = "off" spellcheck = "false" placeholder = "Click or press ‘ ’ ‘ ’ type = "search" > < div id = "help-button" tabindex = "-1" > < a href = "../../help.html" title = "help" > ?< / 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 = "main-heading" > < h1 > Trait < a href = "../index.html" > indexmap< / a > ::< wbr > < a href = "index.html" > map< / a > ::< wbr > < a class = "trait" href = "#" > MutableKeys< / a > < button id = "copy-path" title = "Copy item path to clipboard" > < img src = "../../static.files/clipboard-7571035ce49a181d.svg" width = "19" height = "18" alt = "Copy item path" > < / button > < / h1 > < span class = "out-of-band" > < a class = "src" href = "../../src/indexmap/map/mutable.rs.html#19-47" > source< / a > · < button id = "toggle-all-docs" title = "collapse all docs" > [< span > − < / span > ]< / button > < / span > < / div > < pre class = "rust item-decl" > < code > pub trait MutableKeys: Sealed {
2024-03-11 08:39:13 +00:00
type < a href = "#associatedtype.Key" class = "associatedtype" > Key< / a > ;
type < a href = "#associatedtype.Value" class = "associatedtype" > Value< / a > ;
// Required methods
fn < a href = "#tymethod.get_full_mut2" class = "fn" > get_full_mut2< / a > < Q> (
& mut self,
2024-04-09 10:18:33 +00:00
key: < a class = "primitive" href = "https://doc.rust-lang.org/1.77.1/std/primitive.reference.html" > & Q< / a >
) -> < a class = "enum" href = "https://doc.rust-lang.org/1.77.1/core/option/enum.Option.html" title = "enum core::option::Option" > Option< / a > < (< a class = "primitive" href = "https://doc.rust-lang.org/1.77.1/std/primitive.usize.html" > usize< / a > , & mut Self::< a class = "associatedtype" href = "trait.MutableKeys.html#associatedtype.Key" title = "type indexmap::map::MutableKeys::Key" > Key< / a > , & mut Self::< a class = "associatedtype" href = "trait.MutableKeys.html#associatedtype.Value" title = "type indexmap::map::MutableKeys::Value" > Value< / a > )>
< span class = "where" > where Q: ?< a class = "trait" href = "https://doc.rust-lang.org/1.77.1/core/marker/trait.Sized.html" title = "trait core::marker::Sized" > Sized< / a > + < a class = "trait" href = "https://doc.rust-lang.org/1.77.1/core/hash/trait.Hash.html" title = "trait core::hash::Hash" > Hash< / a > + < a class = "trait" href = "../trait.Equivalent.html" title = "trait indexmap::Equivalent" > Equivalent< / a > < Self::< a class = "associatedtype" href = "trait.MutableKeys.html#associatedtype.Key" title = "type indexmap::map::MutableKeys::Key" > Key< / a > > < / span > ;
2024-03-11 08:39:13 +00:00
< span class = "item-spacer" > < / span > fn < a href = "#tymethod.get_index_mut2" class = "fn" > get_index_mut2< / a > (
& mut self,
2024-04-09 10:18:33 +00:00
index: < a class = "primitive" href = "https://doc.rust-lang.org/1.77.1/std/primitive.usize.html" > usize< / a >
) -> < a class = "enum" href = "https://doc.rust-lang.org/1.77.1/core/option/enum.Option.html" title = "enum core::option::Option" > Option< / a > < (& mut Self::< a class = "associatedtype" href = "trait.MutableKeys.html#associatedtype.Key" title = "type indexmap::map::MutableKeys::Key" > Key< / a > , & mut Self::< a class = "associatedtype" href = "trait.MutableKeys.html#associatedtype.Value" title = "type indexmap::map::MutableKeys::Value" > Value< / a > )> ;
2024-03-11 08:39:13 +00:00
< span class = "item-spacer" > < / span > fn < a href = "#tymethod.retain2" class = "fn" > retain2< / a > < F> (& mut self, keep: F)
2024-04-09 10:18:33 +00:00
< span class = "where" > where F: < a class = "trait" href = "https://doc.rust-lang.org/1.77.1/core/ops/function/trait.FnMut.html" title = "trait core::ops::function::FnMut" > FnMut< / a > (& mut Self::< a class = "associatedtype" href = "trait.MutableKeys.html#associatedtype.Key" title = "type indexmap::map::MutableKeys::Key" > Key< / a > , & mut Self::< a class = "associatedtype" href = "trait.MutableKeys.html#associatedtype.Value" title = "type indexmap::map::MutableKeys::Value" > Value< / a > ) -> < a class = "primitive" href = "https://doc.rust-lang.org/1.77.1/std/primitive.bool.html" > bool< / a > < / span > ;
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 > Opt-in mutable access to < a href = "struct.IndexMap.html" title = "struct indexmap::map::IndexMap" > < code > IndexMap< / code > < / a > keys.< / p >
< p > These methods expose < code > & mut K< / code > , mutable references to the key as it is stored
in the map.
2024-03-27 11:50:56 +00:00
You are allowed to modify the keys in the map < strong > if the modification
2024-03-11 08:39:13 +00:00
does not change the key’ < / strong > .< / p >
< p > If keys are modified erroneously, you can no longer look them up.
This is sound (memory safe) but a logical error hazard (just like
implementing < code > PartialEq< / code > , < code > Eq< / code > , or < code > Hash< / code > incorrectly would be).< / p >
< p > < code > use< / code > this trait to enable its methods for < code > IndexMap< / code > .< / p >
< p > This trait is sealed and cannot be implemented for types outside this crate.< / p >
2024-03-27 11:50:56 +00:00
< / div > < / details > < h2 id = "required-associated-types" class = "section-header" > Required Associated Types< a href = "#required-associated-types" class = "anchor" > §< / a > < / h2 > < div class = "methods" > < section id = "associatedtype.Key" class = "method" > < a class = "src rightside" href = "../../src/indexmap/map/mutable.rs.html#20" > source< / a > < h4 class = "code-header" > type < a href = "#associatedtype.Key" class = "associatedtype" > Key< / a > < / h4 > < / section > < section id = "associatedtype.Value" class = "method" > < a class = "src rightside" href = "../../src/indexmap/map/mutable.rs.html#21" > source< / a > < h4 class = "code-header" > type < a href = "#associatedtype.Value" class = "associatedtype" > Value< / a > < / h4 > < / section > < / div > < 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.get_full_mut2" class = "method" > < a class = "src rightside" href = "../../src/indexmap/map/mutable.rs.html#26-28" > source< / a > < h4 class = "code-header" > fn < a href = "#tymethod.get_full_mut2" class = "fn" > get_full_mut2< / a > < Q> (
2024-03-11 08:39:13 +00:00
& mut self,
2024-04-09 10:18:33 +00:00
key: < a class = "primitive" href = "https://doc.rust-lang.org/1.77.1/std/primitive.reference.html" > & Q< / a >
) -> < a class = "enum" href = "https://doc.rust-lang.org/1.77.1/core/option/enum.Option.html" title = "enum core::option::Option" > Option< / a > < (< a class = "primitive" href = "https://doc.rust-lang.org/1.77.1/std/primitive.usize.html" > usize< / a > , & mut Self::< a class = "associatedtype" href = "trait.MutableKeys.html#associatedtype.Key" title = "type indexmap::map::MutableKeys::Key" > Key< / a > , & mut Self::< a class = "associatedtype" href = "trait.MutableKeys.html#associatedtype.Value" title = "type indexmap::map::MutableKeys::Value" > Value< / a > )> < div class = "where" > where
Q: ?< a class = "trait" href = "https://doc.rust-lang.org/1.77.1/core/marker/trait.Sized.html" title = "trait core::marker::Sized" > Sized< / a > + < a class = "trait" href = "https://doc.rust-lang.org/1.77.1/core/hash/trait.Hash.html" title = "trait core::hash::Hash" > Hash< / a > + < a class = "trait" href = "../trait.Equivalent.html" title = "trait indexmap::Equivalent" > Equivalent< / a > < Self::< a class = "associatedtype" href = "trait.MutableKeys.html#associatedtype.Key" title = "type indexmap::map::MutableKeys::Key" > Key< / a > > ,< / div > < / h4 > < / section > < / summary > < div class = "docblock" > < p > Return item index, mutable reference to key and value< / p >
2024-03-11 08:39:13 +00:00
< p > Computes in < strong > O(1)< / strong > time (average).< / p >
2024-03-27 11:50:56 +00:00
< / div > < / details > < details class = "toggle method-toggle" open > < summary > < section id = "tymethod.get_index_mut2" class = "method" > < a class = "src rightside" href = "../../src/indexmap/map/mutable.rs.html#35" > source< / a > < h4 class = "code-header" > fn < a href = "#tymethod.get_index_mut2" class = "fn" > get_index_mut2< / a > (
2024-03-11 08:39:13 +00:00
& mut self,
2024-04-09 10:18:33 +00:00
index: < a class = "primitive" href = "https://doc.rust-lang.org/1.77.1/std/primitive.usize.html" > usize< / a >
) -> < a class = "enum" href = "https://doc.rust-lang.org/1.77.1/core/option/enum.Option.html" title = "enum core::option::Option" > Option< / a > < (& mut Self::< a class = "associatedtype" href = "trait.MutableKeys.html#associatedtype.Key" title = "type indexmap::map::MutableKeys::Key" > Key< / a > , & mut Self::< a class = "associatedtype" href = "trait.MutableKeys.html#associatedtype.Value" title = "type indexmap::map::MutableKeys::Value" > Value< / a > )> < / h4 > < / section > < / summary > < div class = "docblock" > < p > Return mutable reference to key and value at an index.< / p >
2024-03-11 08:39:13 +00:00
< p > Valid indices are < em > 0 < = index < self.len()< / em > < / p >
< p > Computes in < strong > O(1)< / strong > time.< / p >
2024-03-27 11:50:56 +00:00
< / div > < / details > < details class = "toggle method-toggle" open > < summary > < section id = "tymethod.retain2" class = "method" > < a class = "src rightside" href = "../../src/indexmap/map/mutable.rs.html#44-46" > source< / a > < h4 class = "code-header" > fn < a href = "#tymethod.retain2" class = "fn" > retain2< / a > < F> (& mut self, keep: F)< div class = "where" > where
2024-04-09 10:18:33 +00:00
F: < a class = "trait" href = "https://doc.rust-lang.org/1.77.1/core/ops/function/trait.FnMut.html" title = "trait core::ops::function::FnMut" > FnMut< / a > (& mut Self::< a class = "associatedtype" href = "trait.MutableKeys.html#associatedtype.Key" title = "type indexmap::map::MutableKeys::Key" > Key< / a > , & mut Self::< a class = "associatedtype" href = "trait.MutableKeys.html#associatedtype.Value" title = "type indexmap::map::MutableKeys::Value" > Value< / a > ) -> < a class = "primitive" href = "https://doc.rust-lang.org/1.77.1/std/primitive.bool.html" > bool< / a > ,< / div > < / h4 > < / section > < / summary > < div class = "docblock" > < p > Scan through each key-value pair in the map and keep those where the
2024-03-11 08:39:13 +00:00
closure < code > keep< / code > returns < code > true< / code > .< / p >
< p > The elements are visited in order, and remaining elements keep their
order.< / p >
< p > Computes in < strong > O(n)< / strong > time (average).< / p >
2024-04-09 10:18:33 +00:00
< / div > < / details > < / div > < h2 id = "object-safety" class = "section-header" > Object Safety< a href = "#object-safety" class = "anchor" > §< / a > < / h2 > < div class = "object-safety-info" > This trait is < b > not< / b > < a href = "https://doc.rust-lang.org/1.77.1/reference/items/traits.html#object-safety" > object safe< / a > .< / div > < h2 id = "implementors" class = "section-header" > Implementors< a href = "#implementors" class = "anchor" > §< / a > < / h2 > < div id = "implementors-list" > < details class = "toggle implementors-toggle" > < summary > < section id = "impl-MutableKeys-for-IndexMap%3CK,+V,+S%3E" class = "impl" > < a class = "src rightside" href = "../../src/indexmap/map/mutable.rs.html#52-81" > source< / a > < a href = "#impl-MutableKeys-for-IndexMap%3CK,+V,+S%3E" class = "anchor" > §< / a > < h3 class = "code-header" > impl< K, V, S> < a class = "trait" href = "trait.MutableKeys.html" title = "trait indexmap::map::MutableKeys" > MutableKeys< / a > for < a class = "struct" href = "struct.IndexMap.html" title = "struct indexmap::map::IndexMap" > IndexMap< / a > < K, V, S> < div class = "where" > where
S: < a class = "trait" href = "https://doc.rust-lang.org/1.77.1/core/hash/trait.BuildHasher.html" title = "trait core::hash::BuildHasher" > BuildHasher< / a > ,< / div > < / h3 > < / section > < / summary > < div class = "docblock" > < p > Opt-in mutable access to < a href = "struct.IndexMap.html" title = "struct indexmap::map::IndexMap" > < code > IndexMap< / code > < / a > keys.< / p >
2024-03-11 08:39:13 +00:00
< p > See < a href = "trait.MutableKeys.html" title = "trait indexmap::map::MutableKeys" > < code > MutableKeys< / code > < / a > for more information.< / p >
2024-03-27 11:50:56 +00:00
< / div > < div class = "impl-items" > < section id = "associatedtype.Key-1" class = "associatedtype trait-impl" > < a href = "#associatedtype.Key-1" class = "anchor" > §< / a > < h4 class = "code-header" > type < a href = "#associatedtype.Key" class = "associatedtype" > Key< / a > = K< / h4 > < / section > < section id = "associatedtype.Value-1" class = "associatedtype trait-impl" > < a href = "#associatedtype.Value-1" class = "anchor" > §< / a > < h4 class = "code-header" > type < a href = "#associatedtype.Value" class = "associatedtype" > Value< / a > = V< / h4 > < / section > < / div > < / details > < / div > < script src = "../../trait.impl/indexmap/map/mutable/trait.MutableKeys.js" async > < / script > < / section > < / div > < / main > < / body > < / html >
