Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarifications for set_nonblocking methods #130743

Merged
merged 1 commit into from
Sep 29, 2024

Conversation

YohDeadfall
Copy link
Contributor

Closes #129903.

The issue mentions that send, recv and other operations are interpreted by some users as methods of TcpSocket which led to confusion since it hasn't them. To fix it I added "system" into the documentation as being more precise for two reasons:

  • it's makes it clear that these names are system operations;
  • it doesn't point to the location of these methods like libc because not every system is POSIX compatible.

@rustbot
Copy link
Collaborator

rustbot commented Sep 23, 2024

r? @Mark-Simulacrum

rustbot has assigned @Mark-Simulacrum.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

@rustbot 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 Sep 23, 2024
@Mark-Simulacrum
Copy link
Member

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Sep 28, 2024

📌 Commit e424a8c has been approved by Mark-Simulacrum

It is now in the queue for this repository.

@bors 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 Sep 28, 2024
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Sep 28, 2024
…=Mark-Simulacrum

Clarifications for set_nonblocking methods

Closes rust-lang#129903.

The issue mentions that `send`, `recv` and other operations are interpreted by some users as methods of `TcpSocket` which led to confusion since it hasn't them. To fix it I added "system" into the documentation as being more precise for two reasons:
* it's makes it clear that these names are system operations;
* it doesn't point to the location of these methods like `libc` because not every system is POSIX compatible.
bors added a commit to rust-lang-ci/rust that referenced this pull request Sep 28, 2024
…iaskrgr

Rollup of 4 pull requests

Successful merges:

 - rust-lang#128321 (Update `catch_unwind` doc comments for `c_unwind`)
 - rust-lang#130416 (resolve rust-lang#130122: reword 'sort-by' edge-conditions documentation)
 - rust-lang#130743 (Clarifications for set_nonblocking methods)
 - rust-lang#130983 (Update `browser-ui-test` version and make use of `wait-for*-false` commands)

r? `@ghost`
`@rustbot` modify labels: rollup
bors added a commit to rust-lang-ci/rust that referenced this pull request Sep 29, 2024
…llaumeGomez

Rollup of 5 pull requests

Successful merges:

 - rust-lang#130383 (check if it's rust-lang/rust CI job in `llvm::is_ci_llvm_modified`)
 - rust-lang#130416 (resolve rust-lang#130122: reword 'sort-by' edge-conditions documentation)
 - rust-lang#130537 (rustdoc: add doc comment to DocVisitor)
 - rust-lang#130743 (Clarifications for set_nonblocking methods)
 - rust-lang#131010 (extend comment in global_llvm_features regarding target-cpu=native)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit ee8ca3a into rust-lang:master Sep 29, 2024
6 checks passed
@rustbot rustbot added this to the 1.83.0 milestone Sep 29, 2024
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Sep 29, 2024
Rollup merge of rust-lang#130743 - YohDeadfall:net-nonblocking-doc, r=Mark-Simulacrum

Clarifications for set_nonblocking methods

Closes rust-lang#129903.

The issue mentions that `send`, `recv` and other operations are interpreted by some users as methods of `TcpSocket` which led to confusion since it hasn't them. To fix it I added "system" into the documentation as being more precise for two reasons:
* it's makes it clear that these names are system operations;
* it doesn't point to the location of these methods like `libc` because not every system is POSIX compatible.
@YohDeadfall YohDeadfall deleted the net-nonblocking-doc branch September 29, 2024 17:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-libs Relevant to the library team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

TcpStream::set_nonblocking docs mention non-existent methods
4 participants