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

Documentation for interactive stdio #4934

Open
Darksonn opened this issue Aug 23, 2022 · 0 comments
Open

Documentation for interactive stdio #4934

Darksonn opened this issue Aug 23, 2022 · 0 comments
Labels
A-tokio Area: The main tokio crate M-io Module: tokio/io T-docs Topic: documentation

Comments

@Darksonn
Copy link
Contributor

The stdin function currently says:

For interactive uses, it is recommended to spawn a thread dedicated to user input and use blocking IO directly in that thread.

However, this does not give very many details. There should be an example in the docs of using tokio's stdio for a non-interactive usecase and one that properly uses a dedicated thread for interactive IO.

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 M-io Module: tokio/io T-docs Topic: documentation
Projects
None yet
Development

No branches or pull requests

1 participant