diff options
| author | Manish Goregaokar <manishsmail@gmail.com> | 2015-03-04 22:03:47 +0530 |
|---|---|---|
| committer | Manish Goregaokar <manishsmail@gmail.com> | 2015-03-05 12:38:34 +0530 |
| commit | ca13fd2a07d5f9417b0f32afec6ea599451d8f64 (patch) | |
| tree | 3d4934ab27a81ba88220d692f1e283dcd17e7ba2 /src/libstd | |
| parent | 145b83e63355c672f8e43129f8e7833fac35dce2 (diff) | |
| parent | 0a1776495c48db19a8e1fe27acc81bab908e256a (diff) | |
| download | rust-ca13fd2a07d5f9417b0f32afec6ea599451d8f64.tar.gz rust-ca13fd2a07d5f9417b0f32afec6ea599451d8f64.zip | |
Rollup merge of #22973 - djmally:coll_docs, r=Gankro
Diffstat (limited to 'src/libstd')
| -rw-r--r-- | src/libstd/collections/mod.rs | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/src/libstd/collections/mod.rs b/src/libstd/collections/mod.rs index 100d3e6ed4a..caada8ae50f 100644 --- a/src/libstd/collections/mod.rs +++ b/src/libstd/collections/mod.rs @@ -78,7 +78,7 @@ //! * You want a bit vector. //! //! ### Use a `BitSet` when: -//! * You want a `VecSet`. +//! * You want a `BitVec`, but want `Set` properties //! //! ### Use a `BinaryHeap` when: //! * You want to store a bunch of elements, but only ever want to process the "biggest" @@ -89,7 +89,8 @@ //! //! Choosing the right collection for the job requires an understanding of what each collection //! is good at. Here we briefly summarize the performance of different collections for certain -//! important operations. For further details, see each type's documentation. +//! important operations. For further details, see each type's documentation, and note that the +//! names of actual methods may differ from the tables below on certain collections. //! //! Throughout the documentation, we will follow a few conventions. For all operations, //! the collection's size is denoted by n. If another collection is involved in the operation, it @@ -280,16 +281,16 @@ //! a variant of the `Entry` enum. //! //! If a `Vacant(entry)` is yielded, then the key *was not* found. In this case the -//! only valid operation is to `set` the value of the entry. When this is done, +//! only valid operation is to `insert` a value into the entry. When this is done, //! the vacant entry is consumed and converted into a mutable reference to the //! the value that was inserted. This allows for further manipulation of the value //! beyond the lifetime of the search itself. This is useful if complex logic needs to //! be performed on the value regardless of whether the value was just inserted. //! //! If an `Occupied(entry)` is yielded, then the key *was* found. In this case, the user -//! has several options: they can `get`, `set`, or `take` the value of the occupied +//! has several options: they can `get`, `insert`, or `remove` the value of the occupied //! entry. Additionally, they can convert the occupied entry into a mutable reference -//! to its value, providing symmetry to the vacant `set` case. +//! to its value, providing symmetry to the vacant `insert` case. //! //! ### Examples //! @@ -329,7 +330,7 @@ //! use std::collections::btree_map::{BTreeMap, Entry}; //! //! // A client of the bar. They have an id and a blood alcohol level. -//! struct Person { id: u32, blood_alcohol: f32 }; +//! struct Person { id: u32, blood_alcohol: f32 } //! //! // All the orders made to the bar, by client id. //! let orders = vec![1,2,1,2,3,4,1,2,2,3,4,1,1,1]; |
