Update documentation for Once to reference std::sync::OnceLock.
#159
Conversation
briansmith
force-pushed
the
b/unlike-std
branch
from
ff94aac to
c43251e
Compare
briansmith
force-pushed
the
b/unlike-std
branch
from
c43251e to
f8407dd
Compare
| /// Unlike its `std::sync` equivalent, this is generalized such that the closure returns a | ||
| /// value to be stored by the [`Once`] (`std::sync::Once` can be trivially emulated with | ||
| /// `Once`). | ||
| /// This is analogous to `std::sync::OnceLock`. |
There was a problem hiding this comment.
Hmm, I think this is probably too strong a statement. They're definitely very similar, but the APIs differ enough that I'd probably go for something like:
This type has similar behaviour to `std::sync::OnceLock`.
There was a problem hiding this comment.
The previous "equivalent" was already much stronger language than "analogous," which isn't any stronger of a statement than "similar behavio[u]r." For most people, if they need a spinlock variant of std::sync::OnceLock then they'll consider spin::Once.
| //! - [`Once`] owns the value returned by its `call_once` initializer. | ||
| //! |
There was a problem hiding this comment.
What's the reason for removing this?
There was a problem hiding this comment.
Previously, we were comparing spin::Once to std::sync::Once, which didn't own the result of the initializer. Now we're comparing it to OnceLock, which does own the result of the initializer.
|
Apologies for not finishing off this review earlier, I've had a lot on this week. I should be in a position to finish this off tomorrow. |
|
The same updates could probably be applied to |
No description provided.