Add examples for std::pin::Pin new() and into_inner() methods #104195

ch-iv · 2022-11-09T14:32:28Z

rustbot · 2022-11-09T14:32:35Z

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @Mark-Simulacrum (or someone else) soon.

Please see the contribution instructions for more information.

rustbot · 2022-11-09T14:32:37Z

Hey! It looks like you've submitted a new PR for the library teams!

If this PR contains changes to any rust-lang/rust public library APIs then please comment with @rustbot label +T-libs-api -T-libs to tag it appropriately. If this PR contains changes to any unstable APIs please edit the PR description to add a link to the relevant API Change Proposal or create one if you haven't already. If you're unsure where your change falls no worries, just leave it as is and the reviewer will take a look and make a decision to forward on if necessary.

Examples of T-libs-api changes:

Stabilizing library features
Introducing insta-stable changes such as new implementations of existing stable traits on existing stable types
Introducing new or changing existing unstable library APIs (excluding permanently unstable features / features without a tracking issue)
Changing public documentation in ways that create new stability guarantees
Changing observable runtime behavior of library APIs

Noratrieb · 2022-11-09T20:24:35Z

library/core/src/pin.rs

+    /// use std::pin::Pin;
+    ///
+    /// let val: u8 = 5;
+    /// // Wrap the value in a pin to make sure it doesn't move


This isn't quite accurate. Since Target: Unpin, the value can move again.

Suggested change

/// // Wrap the value in a pin to make sure it doesn't move

/// // The value doesn't care about being moved, so we can pin it just fine

I don't like my wording here a lot, feel free to improve it, but something like this is better.

I guess that a better option is Pin the value in memory to make sure that during the program lifecycle the value is not moved in another memory address?

…into documentation-104107

library/core/src/pin.rs

vincenzopalazzo

Some others comment regarding the PR are:

Use the Fixes https://github.com/rust-lang/rust/issues/104107 to make sure that the PR is linked with the issue
Try to squash the commit in a single one if the commit are simple the same things

Co-authored-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>

Mark-Simulacrum · 2022-11-13T22:57:17Z

library/core/src/pin.rs

+    ///
+    /// let val: u8 = 5;
+    /// // We can pin the value, since it doesn't care about being moved
+    /// let pinned: Pin<&u8> = Pin::new(&val);


It seems like an example of Pin with a shared reference is probably not the best bet -- most users will not want that. I think we should demonstrate with a &mut reference at least.

let mut val: u8 = 5; let mut pinned: Pin<&mut u8> = Pin::new(&mut val); println!("{}", pinned); // 5 pinned.as_mut().set(10); println!("{}", pinned); // 10

Would this work?

Mark-Simulacrum · 2022-11-13T23:00:18Z

@rustbot author

yoshuawuyts · 2022-11-22T17:52:16Z

cc/ @rust-lang/wg-async I ran out of time to review this before going out of office. Can others take a look at this, perhaps during the next triage? I want to make sure we don't let this slip. Thanks!

vincenzopalazzo · 2022-11-22T22:58:01Z

@rustbot label +A-async-await

So in this way, it is indexed by penguin our friendly triage bot 😸

ch-iv · 2022-11-23T22:38:55Z

@rustbot label -S-waiting-on-author +S-waiting-on-review

Mark-Simulacrum · 2022-12-05T03:11:15Z

r? @yoshuawuyts

eholk · 2022-12-06T01:47:23Z

@bors r+

bors · 2022-12-06T01:47:25Z

📌 Commit 7a47e2c has been approved by eholk

It is now in the queue for this repository.

Add examples for std::pin::Pin new() and into_inner() methods Fixes rust-lang#104107

klensy · 2022-12-06T12:28:07Z

https://rustc-dev-guide.rust-lang.org/git.html#no-merge-policy, commits should be rebased/squashed

matthiaskrgr · 2022-12-06T12:29:11Z

@bors r-

vincenzopalazzo · 2022-12-08T17:28:42Z

@ch-iv could you rebase and squash the commit in a single one? so we can get this in soon!

…=eholk docs: improve pin docs Override rust-lang#104195 with a full cleanup of the git history, now it should be ready to be merged. r? `@eholk` `@rustbot` label +A-async-await

…=eholk docs: improve pin docs Override rust-lang#104195 with a full cleanup of the git history, now it should be ready to be merged. r? ``@eholk`` ``@rustbot`` label +A-async-await

docs: improve pin docs Override rust-lang/rust#104195 with a full cleanup of the git history, now it should be ready to be merged. r? ``@eholk`` ``@rustbot`` label +A-async-await

ch-iv added 2 commits November 8, 2022 09:27

Add an example for Pin::new()

fe2f40a

Add example for the into_inner() method

8b5379e

rustbot assigned Mark-Simulacrum Nov 9, 2022

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels Nov 9, 2022

fix formatting

dfa90e7

Noratrieb reviewed Nov 9, 2022

View reviewed changes

ch-iv added 3 commits November 9, 2022 16:50

Merge branch 'documentation-104107' of https://github.com/ch-iv/rust …

fd8ebea

…into documentation-104107

Repace inaccruate comment

6f48b60

formatting

a4ee02b

vincenzopalazzo suggested changes Nov 10, 2022

View reviewed changes

library/core/src/pin.rs Outdated Show resolved Hide resolved

vincenzopalazzo reviewed Nov 10, 2022

View reviewed changes

Update library/core/src/pin.rs

06c2ce0

Co-authored-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>

Mark-Simulacrum reviewed Nov 13, 2022

View reviewed changes

rustbot added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Nov 13, 2022

rustbot added the A-async-await Area: Async & Await label Nov 22, 2022

ch-iv and others added 2 commits November 23, 2022 16:11

Merge branch 'rust-lang:master' into documentation-104107

0b1ead3

Demonstrate with an &mut reference

7a47e2c

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Nov 23, 2022

rustbot assigned yoshuawuyts and unassigned Mark-Simulacrum Dec 5, 2022

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Dec 6, 2022

matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Dec 6, 2022

Rollup merge of rust-lang#104195 - ch-iv:documentation-104107, r=eholk

7b2f2a8

Add examples for std::pin::Pin new() and into_inner() methods Fixes rust-lang#104107

matthiaskrgr mentioned this pull request Dec 6, 2022

Rollup of 11 pull requests #105360

Closed

bors added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Dec 6, 2022

klensy mentioned this pull request Dec 6, 2022

Add tidy check to deny merge commits #105058

Merged

vincenzopalazzo mentioned this pull request Dec 19, 2022

docs: improve pin docs #105902

Merged

ch-iv closed this by deleting the head repository Jan 20, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add examples for std::pin::Pin new() and into_inner() methods #104195

Add examples for std::pin::Pin new() and into_inner() methods #104195

ch-iv commented Nov 9, 2022 •

edited

Loading

rustbot commented Nov 9, 2022

rustbot commented Nov 9, 2022

Noratrieb Nov 9, 2022

vincenzopalazzo Nov 10, 2022

vincenzopalazzo left a comment

Mark-Simulacrum Nov 13, 2022

ch-iv Nov 22, 2022

Mark-Simulacrum commented Nov 13, 2022

yoshuawuyts commented Nov 22, 2022 •

edited

Loading

vincenzopalazzo commented Nov 22, 2022 •

edited

Loading

ch-iv commented Nov 23, 2022

Mark-Simulacrum commented Dec 5, 2022

eholk commented Dec 6, 2022

bors commented Dec 6, 2022

klensy commented Dec 6, 2022

matthiaskrgr commented Dec 6, 2022

vincenzopalazzo commented Dec 8, 2022

	/// // Wrap the value in a pin to make sure it doesn't move
	/// // The value doesn't care about being moved, so we can pin it just fine

Add examples for std::pin::Pin new() and into_inner() methods #104195

Add examples for std::pin::Pin new() and into_inner() methods #104195

Conversation

ch-iv commented Nov 9, 2022 • edited Loading

rustbot commented Nov 9, 2022

rustbot commented Nov 9, 2022

Noratrieb Nov 9, 2022

Choose a reason for hiding this comment

vincenzopalazzo Nov 10, 2022

Choose a reason for hiding this comment

vincenzopalazzo left a comment

Choose a reason for hiding this comment

Mark-Simulacrum Nov 13, 2022

Choose a reason for hiding this comment

ch-iv Nov 22, 2022

Choose a reason for hiding this comment

Mark-Simulacrum commented Nov 13, 2022

yoshuawuyts commented Nov 22, 2022 • edited Loading

vincenzopalazzo commented Nov 22, 2022 • edited Loading

ch-iv commented Nov 23, 2022

Mark-Simulacrum commented Dec 5, 2022

eholk commented Dec 6, 2022

bors commented Dec 6, 2022

klensy commented Dec 6, 2022

matthiaskrgr commented Dec 6, 2022

vincenzopalazzo commented Dec 8, 2022

ch-iv commented Nov 9, 2022 •

edited

Loading

yoshuawuyts commented Nov 22, 2022 •

edited

Loading

vincenzopalazzo commented Nov 22, 2022 •

edited

Loading