macros: add pin! macro #2163
macros: add pin! macro #2163
Conversation
Used for stack pinning and based on `pin_mut!` from the pin-util crate. Pinning is used often when working with stream operators and the select! macro. Given the small size of `pin!` it makes more sense to include a version than re-export one from a separate crate or require the user to depend on `pin-util` themselves.
| /// } | ||
| /// ``` | ||
| #[macro_export] | ||
| macro_rules! pin { |
There was a problem hiding this comment.
Why pin_mut?
The macro takes the value by ownership. I don't see when you would want a &self version... you can also always go to &self from mut.
There was a problem hiding this comment.
Because it pins a &mut Self reference even though it moves the value. It still produces a pinned mutable reference.
There was a problem hiding this comment.
mut is just noise in this case as there is no other variant.
There was a problem hiding this comment.
For example, it is io::Read::read and not io::Read::read_mut
There was a problem hiding this comment.
idk I think its not that nosiy and there is already a precedent in the ecosystem 🤷♂
I also think in this case its fine to be explicit that its a pin of a mutable ref over just a pin.
There was a problem hiding this comment.
Idiomatically, using an _mut suffix means there is a version w/o _mut. If there is a pin_mut! there should be a pin!.
There was a problem hiding this comment.
ill concede if we can at least reference that this is the same as pin_mut
Used for stack pinning and based on
pin_mut!from the pin-util crate.Pinning is used often when working with stream operators and the select!
macro. Given the small size of
pin!it makes more sense to include aversion than re-export one from a separate crate or require the user to
depend on
pin-utilthemselves.