docs: Add FAQ section?

Open taiki-e opened this issue 2 years ago • 1 comments

It might be nice with a section mentioning the often overlooked standard library APIs such as Option::as_pin_mut (e.g., https://twitter.com/fasterthanlime/status/1377229099622662146, https://github.com/hyperium/tonic/pull/1377, https://github.com/tower-rs/tower/pull/316#discussion_r319770004), Pin::as_mut (e.g., https://github.com/taiki-e/pin-project/issues/345), Pin::set (e.g., https://rust-lang.zulipchat.com/#narrow/stream/136281-t-opsem/topic/.60Pin.60.20used.20for.20encapsulation/near/300322988, https://github.com/tower-rs/tower/pull/323#discussion_r322239400), etc., and cases like https://github.com/taiki-e/pin-project/issues/226.

Related discussion: https://github.com/taiki-e/pin-project/issues/89#issuecomment-531957938

Apr 28 '23 13:04 taiki-e

Q. Do I require to learn about obscure concepts like structural pinning when using this crate?

A. No, pin-project is intended to be safe to use without understand structural pinning.

https://x.com/_taiki_e/status/1846184768683364790

Oct 15 '24 14:10 taiki-e