`slice_shift_char` splits a `str` into it's leading `char` and the remainder
of the `str`. Currently, it returns a `(Option<char>, &str)` such that:
"bar".slice_shift_char() => (Some('b'), "ar")
"ar".slice_shift_char() => (Some('a'), "r")
"r".slice_shift_char() => (Some('r'), "")
"".slice_shift_char() => (None, "")
This is a little odd. Either a `str` can be split into both a head and a
tail or it cannot. So the return type should be `Option<(char, &str)>`.
With the current behaviour, in the case of the empty string, the `str`
returned is meaningless - it is always the empty string.
This commit changes slice_shift_char so that:
"bar".slice_shift_char() => Some(('b', "ar"))
"ar".slice_shift_char() => Some(('a', "r"))
"r".slice_shift_char() => Some(('r', ""))
"".slice_shift_char() => None
[breaking-change]
Fix for task in Metabug #18009 (Rebased version of https://github.com/rust-lang/rust/pull/18170)
This changes much of about how RingBuf functions. `lo`, `nelts` are replaced by a more traditional `head` and`tail`. The `Vec<Option<T>>` is replaced by a bare pointer that is managed by the `RingBuf` itself. This also expects the ring buffer to always be size that is a power of 2.
This change also includes a number of new tests to cover the some areas that could be of concern with manual memory management.
The benchmarks have been reworked since the old ones were benchmarking of the Ring buffers growth rather then the actual test.
The unit test suite have been expanded, and exposed some bugs in `fn get()` and `fn get_mut()`
## Benchmark
**Before:**
```
test ring_buf::tests::bench_grow_1025 ... bench: 8919 ns/iter (+/- 87)
test ring_buf::tests::bench_iter_1000 ... bench: 924 ns/iter (+/- 28)
test ring_buf::tests::bench_mut_iter_1000 ... bench: 918 ns/iter (+/- 6)
test ring_buf::tests::bench_new ... bench: 15 ns/iter (+/- 0)
test ring_buf::tests::bench_pop_100 ... bench: 294 ns/iter (+/- 9)
test ring_buf::tests::bench_pop_front_100 ... bench: 948 ns/iter (+/- 32)
test ring_buf::tests::bench_push_back_100 ... bench: 291 ns/iter (+/- 16)
test ring_buf::tests::bench_push_front_100 ... bench: 311 ns/iter (+/- 27
```
**After:**
```
test ring_buf::tests::bench_grow_1025 ... bench: 2209 ns/iter (+/- 169)
test ring_buf::tests::bench_iter_1000 ... bench: 534 ns/iter (+/- 27)
test ring_buf::tests::bench_mut_iter_1000 ... bench: 515 ns/iter (+/- 28)
test ring_buf::tests::bench_new ... bench: 11 ns/iter (+/- 0)
test ring_buf::tests::bench_pop_100 ... bench: 170 ns/iter (+/- 5)
test ring_buf::tests::bench_pop_front_100 ... bench: 171 ns/iter (+/- 11)
test ring_buf::tests::bench_push_back_100 ... bench: 172 ns/iter (+/- 13)
test ring_buf::tests::bench_push_front_100 ... bench: 158 ns/iter (+/- 12)
```
This moves chars() and lines() out of Buffer and into separate traits (CharsBuffer and LinesBuffer respectively) - this matches the pattern used for bytes() on Reader (with BytesReader).
(I came across this when I wanted a trait object of a Buffer, so that I could use read_line(); rustc errors about std::io::Buffer not being object-safe.)
[breaking-change]
Any uses of Buffer::lines() will need to use the new trait std::io::LinesBuffer.
The same is true for Buffer::chars() with std::io::CharsBuffer.
