This blog post goes into some specifics of Rust reusing Vec allocations and some of the consequences. I think it's really worth a read to better understand Vecs. From what I understand, it is possible that Rust will reuse the allocation of vec_a
in your case, but it ultimately is quite complicated.
Rust
Welcome to the Rust community! This is a place to discuss about the Rust programming language.
Wormhole
Credits
- The icon is a modified version of the official rust logo (changing the colors to a gradient and black background)
That was a super interesting and informative read! Exactly what I was hoping to find when I posted this, thanks!
I don't know and don't think so, but what you are doing is better done with retain anyways.
I mean, the actual operation is just an example, of course. Feel free to make it a .map()
operation instead. The strings couldn’t be reused then, but the vector’s allocation still could… in theory.
map()
can still be used with Vec::iter_mut()
, filter_map()
can be replaced with Vec::retain_mut()
.
Yeah, that's helpful if I would be currently optimizing a hot loop now. But I was really just using it as an example. Also, retain_mut()
doesn't compose as well.
I'd much rather write:
let vec_a: Vec<String> = /* ... */;
let vec_b: Vec<String> = vec_a
.into_iter()
.filter(some_filter)
.map(some_map_fn)
.collect();
Over:
let mut vec_a: Vec<String> = /* ... */;
vec_a.retain_mut(|x| if some_filter(x) {
*x = some_map_fn(*x); // Yikes, cannot move out of reference.
true
} else {
false
});
And it would be nice if that would be optimized the same. After all, the point of Rust's iterators is to provide zero-cost abstractions. In my opinion, functions like retain_mut()
represent a leakiness to that abstraction, because the alternative turns out to not be zero cost.
Is it really fair to say retain doesn't compose as well just because it requires reference-based update instead of move-based? I also think using move semantics for in-place updates makes it harder to optimise things like a single field being updated on a large struct.
It also seems harsh to say iterators aren't a zero-cost abstraction if they miss an optimisation that falls outside what the API promises. It's natural to expect collect
to allocate, no?
But I'm only writing this because I wonder if I haven't understood your point fully.
(Side note: I think you could implement the API you want on top of retain_mut
by using std::mem::replace
with a default value, but you'd be hoping that the compiler optimises away all the replace
calls when it inlines and sees the code can't panic. Idk if that would actually work.)
It also seems harsh to say iterators aren’t a zero-cost abstraction if they miss an optimisation that falls outside what the API promises. It’s natural to expect collect to allocate, no?
You're right, I wouldn't say iterators aren't a zero-cost abstraction. But most abstractions are also leaky -- it's just the extent in which the leakiness is exposed that makes them more or less effective. As such, saying to just use retain_mut
instead of the iterator approach highlights the shortcoming of the abstraction. But if the same results could be achieved while still using the same iterator, that would make that abstraction more useful and consistent. And that's great, because that means we need to worry less when using iterators :)
The composability doesn't have much to do with whether it's a reference or a move, it's because it bypasses usage of the Iterator
methods. Iterators chains can consist of filter
, map
and other operations, which allows various functions and/or closures to be composed together. Whereas with retain_mut()
there isn't really a chain and functions you may otherwise use in an iterator chain become harder to (re)use.
https://blog.polybdenum.com/2024/01/17/identifying-the-collect-vec-memory-leak-footgun.html might be relevant to your question.
along with the related https://github.com/rust-lang/rust/issues/120091
Thanks! That’s very much what I was looking for!
To be fair, these alternatives are also limited to the case where the item type stays the same.
The standard library does have some specialisation internally for certain iterators and collection combinations. Not sure if it will optimise that one specifically, but Vec::into_iter().collect::<Vec>()
is optimised (it may look silly, but it comes up with functions returning impl Iterator
I thought this was the point of vec.drain(..).collect()
.