tock-cells: change OptionalCell::map to pass a copy into the closure
#3535
Conversation
|
On the call, we also discussed renaming the |
|
@kupiakos It's simple enough to be tacked onto here, but given there's already a history behind that (#2531, #2531), having the discussion in a separate PR seems reasonable. Happy to be the one to take the blame here and creating the PR, given I initially introduced Apart from that, I do think that these changes are mostly orthogonal, right? |
5c4fd1c to
26bb869
Compare
|
I implemented this change throughout the Tock codebase. Most of these changes have been done mechanically through Unsurprisingly, the diff confirms that we've been dereferencing the closure parameter almost everywhere, implicitly copying it. This confirms that this change more closely reflects the intended behavior. The actual change to |
|
For context, this has been brought up by @kupiakos on the call today, and was also the source of confusion for some OpenTitan developers. |
Pull Request Overview
This pull request changes the semantics of
OptionalCell::mapto move a copy of the internalOption's value into the provided closure. Proving a mutable reference to a copy that is then immediately discarded is very confusing.An alternative design would remove the
mapAPIs and add aget()method, which returns anOption<T>. Then we can use themap*methods on that returned type.Testing Strategy
This pull request was tested by compiling.
TODO or Help Wanted
This pull request still needs porting of the rest of the kernel to this new interface. This should be mostly mechanical changes.
Documentation Updated
/docs, or no updates are required.Formatting
make prepush.