jmaargh 95dc353006 Fix documentation for with_capacity and reserve families of methods ...

Documentation for the following methods

    with_capacity
    with_capacity_in
    with_capacity_and_hasher
    reserve
    reserve_exact
    try_reserve
    try_reserve_exact

was inconsistent and often not entirely correct where they existed on the following types

    Vec
    VecDeque
    String
    OsString
    PathBuf
    BinaryHeap
    HashSet
    HashMap
    BufWriter
    LineWriter

since the allocator is allowed to allocate more than the requested capacity in all such cases, and will frequently "allocate" much more in the case of zero-sized types (I also checked BufReader, but there the docs appear to be accurate as it appears to actually allocate the exact capacity).

Some effort was made to make the documentation more consistent between types as well.

Fix with_capacity* methods for Vec

Fix *reserve*  methods for Vec

Fix docs for *reserve* methods of VecDeque

Fix docs for String::with_capacity

Fix docs for *reserve* methods of String

Fix docs for OsString::with_capacity

Fix docs for *reserve* methods on OsString

Fix docs for with_capacity* methods on HashSet

Fix docs for *reserve methods of HashSet

Fix docs for with_capacity* methods of HashMap

Fix docs for *reserve methods on HashMap

Fix expect messages about OOM in doctests

Fix docs for BinaryHeap::with_capacity

Fix docs for *reserve* methods of BinaryHeap

Fix typos

Fix docs for with_capacity on BufWriter and LineWriter

Fix consistent use of `hasher` between `HashMap` and `HashSet`

Fix warning in doc test

Add test for capacity of vec with ZST

Fix doc test error

2022-06-19 20:46:49 +01:00

..

arc.rs

Add Weak may_dangle tests

2021-05-20 19:42:29 -07:00

borrow.rs

…

boxed.rs

Revert accidental stabilization

2022-03-10 14:36:51 +00:00

btree_set_hash.rs

Include the length in BTree hashes

2021-10-01 12:29:09 -07:00

c_str.rs

Remove use of reverted std::ffi::c_char

2022-04-27 14:01:04 -07:00

const_fns.rs

impl const Default for Box<[T]> and Box<str>

2022-04-11 12:14:18 -07:00

cow_str.rs

…

fmt.rs

Debug print char 0 as '\0' rather than '\u{0}'

2022-03-27 04:49:10 -07:00

heap.rs

Rename AllocRef to Allocator and (de)alloc to (de)allocate

2020-12-04 14:47:15 +01:00

lib.rs

Stabilize const_intrinsic_copy

2022-06-08 20:17:28 +09:00

linked_list.rs

Classify BinaryHeap & LinkedList unit tests as such

2022-03-11 11:33:59 +01:00

rc.rs

Add Weak may_dangle tests

2021-05-20 19:42:29 -07:00

slice.rs

Use Box::new() instead of box syntax in alloc tests

2022-05-29 00:41:14 +02:00

str.rs

improve case conversion happy path

2022-05-26 13:18:57 +01:00

string.rs

Use implicit capture syntax in format_args

2022-03-10 10:23:40 -05:00

thin_box.rs

Avoid zero-sized allocs in ThinBox if T and H are both ZSTs.

2022-05-27 22:12:20 -07:00

vec_deque.rs

Use implicit capture syntax in format_args

2022-03-10 10:23:40 -05:00

vec.rs

Fix documentation for with_capacity and reserve families of methods

2022-06-19 20:46:49 +01:00