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

tokio: make all windows docs visible in unix builds #5530

Merged
merged 4 commits into from Mar 14, 2023

Conversation

satakuma
Copy link
Member

@satakuma satakuma commented Mar 5, 2023

This PR makes all Windows-specific documentation visible in Unix builds similarly to the docs for named pipes.

Items which should be now visible:

  • tokio::fs::symlink_dir
  • tokio::fs::symlink_file
  • tokio::fs::OpenOptions methods (custom_flags, access_mode, share_mode, attributes, security_qos_flags)
  • {AsRawHandle, FromRawHandle} impls for tokio::fs::File
  • AsRawHandle impl for tokio::io::{Stdin, Stdout, Stderr}
  • AsRawSocket impl for tokio::net::{TcpListener, TcpStream, UdpSocket}
  • {AsRawSocket, FromRawSocket, IntoRawSocket} for tokio::net::TcpSocket
  • AsRawHandle impl for tokio::process::{ChildStdin, ChildStdout, ChildStderr}
  • tokio::process::Command::creation_flags
  • tokio::process::Child::raw_handle

View rendered docs

Resolves #5499

@satakuma
Copy link
Member Author

satakuma commented Mar 5, 2023

Now I see that this will merge conflict with #5514, I can wait until that PR is merged first.

@Darksonn Darksonn added T-docs Topic: documentation A-tokio Area: The main tokio crate labels Mar 6, 2023
@satakuma satakuma marked this pull request as draft March 12, 2023 15:02
@satakuma
Copy link
Member Author

Updated to include AsHandle/AsSocket implementations as well.

@satakuma satakuma marked this pull request as ready for review March 13, 2023 11:30
@satakuma satakuma merged commit 4ea6320 into tokio-rs:master Mar 14, 2023
50 checks passed
@satakuma satakuma deleted the windows-docs branch March 14, 2023 22:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-tokio Area: The main tokio crate T-docs Topic: documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

missing documentation for Windows-specific tokio::fs functions
2 participants