Skip to content

doc: Created a simple example for tokio::process::ChildStdin#4479

Merged
ipetkov merged 3 commits intotokio-rs:masterfrom
coral:coral_documentation_update
Feb 12, 2022
Merged

doc: Created a simple example for tokio::process::ChildStdin#4479
ipetkov merged 3 commits intotokio-rs:masterfrom
coral:coral_documentation_update

Conversation

@coral
Copy link
Copy Markdown
Contributor

@coral coral commented Feb 7, 2022 •
edited by Darksonn
Loading

Motivation

I struggled with figuring out how to effectively use ChildStdin in tokio::process . There are a lot of examples on how to capture stdout but only one combined example with stdin which focuses more on chaining. I've found this more well documented in other languages (Go, Python).

Solution

I created a quick example which showcases how to write to stdin but also highlighting that the user needs to drop the handle for EOF to be signaled.

Closes: #4477

@coral coral mentioned this pull request Feb 7, 2022
Closed
@coral coral changed the title Created a simple example for tokio::process::ChildStdin doc: Created a simple example for tokio::process::ChildStdin Feb 7, 2022
@Darksonn Darksonn added A-tokio Area: The main tokio crate M-process Module: tokio/process T-docs Topic: documentation labels Feb 7, 2022
@ipetkov ipetkov self-assigned this Feb 8, 2022
ipetkov
ipetkov reviewed Feb 8, 2022
View reviewed changes
Copy link
Copy Markdown
Member

@ipetkov ipetkov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for addressing this @coral, looks great!

Just have one suggestion to add to do the docs. Although this example is technically correct (sort will read all input before sending any output), it may not be the case for all commands, and it may be good to call out explicitly in the example

@coral @ipetkov
Update tokio/src/process/mod.rs
26e54c5 
Co-authored-by: Ivan Petkov <ivanppetkov@gmail.com>
@ipetkov ipetkov merged commit ed187dd into tokio-rs:master Feb 12, 2022
hawkw added a commit that referenced this pull request Feb 15, 2022
@hawkw
chore: prepare Tokio v1.16.2 release
a6dd24a 
# 1.16.2 (February 15, 2022)

This release updates the minimum supported Rust version (MSRV) to 1.49,
the `mio` dependency to v0.8, and the (optional) `parking_lot`
dependency to v0.12. Additionally, it contains several bug fixes, as
well as internal refactoring and performance improvements.

### Fixed

- time: prevent panicking in `sleep` with large durations ([#4495])
- time: eliminate potential panics in `Instant` arithmetic on platforms
  where `Instant::now` is not monotonic ([#4461])
- io: fix `DuplexStream` not participating in cooperative yielding
  ([#4478])
- rt: fix potential double panic when dropping a `JoinHandle` ([#4430])

### Changed

- update minimum supported Rust version to 1.49 ([#4457])
- update `parking_lot` dependency to v0.12.0 ([#4459])
- update `mio` dependency to v0.8 ([#4449])
- rt: remove an unnecessary lock in the blocking pool ([#4436])
- rt: remove an unnecessary enum in the basic scheduler ([#4462])
- time: use bit manipulation instead of modulo to improve performance
  ([#4480])
- net: use `std::future::Ready` instead of our own `Ready` future
  ([#4271])
- replace deprecated `atomic::spin_loop_hint` with `hint::spin_loop`
  ([#4491])
- fix miri failures in intrusive linked lists ([#4397])

### Documented

- io: add an example for `tokio::process::ChildStdin` ([#4479])

### Unstable

The following changes only apply when building with `--cfg
tokio_unstable`:

- task: fix missing location information in `tracing` spans generated by
  `spawn_local` ([#4483])
- task: add `JoinSet` for managing sets of tasks ([#4335])
- metrics: fix compilation error on MIPS ([#4475])
- metrics: fix compilation error on arm32v7 ([#4453])

[#4495]: #4495
[#4461]: #4461
[#4478]: #4478
[#4430]: #4430
[#4457]: #4457
[#4459]: #4459
[#4449]: #4449
[#4462]: #4462
[#4436]: #4436
[#4480]: #4480
[#4271]: #4271
[#4491]: #4491
[#4397]: #4397
[#4479]: #4479
[#4483]: #4483
[#4335]: #4335
[#4475]: #4475
[#4453]: #4453
@hawkw hawkw mentioned this pull request Feb 15, 2022
Merged
hawkw added a commit that referenced this pull request Feb 16, 2022
@hawkw
chore: prepare Tokio v1.17.0 release (#4504)
43c224f 
# 1.17.0 (February 16, 2022)

This release updates the minimum supported Rust version (MSRV) to 1.49,
the `mio` dependency to v0.8, and the (optional) `parking_lot`
dependency to v0.12. Additionally, it contains several bug fixes, as
well as internal refactoring and performance improvements.

### Fixed

- time: prevent panicking in `sleep` with large durations ([#4495])
- time: eliminate potential panics in `Instant` arithmetic on platforms
  where `Instant::now` is not monotonic ([#4461])
- io: fix `DuplexStream` not participating in cooperative yielding
  ([#4478])
- rt: fix potential double panic when dropping a `JoinHandle` ([#4430])

### Changed

- update minimum supported Rust version to 1.49 ([#4457])
- update `parking_lot` dependency to v0.12.0 ([#4459])
- update `mio` dependency to v0.8 ([#4449])
- rt: remove an unnecessary lock in the blocking pool ([#4436])
- rt: remove an unnecessary enum in the basic scheduler ([#4462])
- time: use bit manipulation instead of modulo to improve performance
  ([#4480])
- net: use `std::future::Ready` instead of our own `Ready` future
  ([#4271])
- replace deprecated `atomic::spin_loop_hint` with `hint::spin_loop`
  ([#4491])
- fix miri failures in intrusive linked lists ([#4397])

### Documented

- io: add an example for `tokio::process::ChildStdin` ([#4479])

### Unstable

The following changes only apply when building with `--cfg
tokio_unstable`:

- task: fix missing location information in `tracing` spans generated by
  `spawn_local` ([#4483])
- task: add `JoinSet` for managing sets of tasks ([#4335])
- metrics: fix compilation error on MIPS ([#4475])
- metrics: fix compilation error on arm32v7 ([#4453])

[#4495]: #4495
[#4461]: #4461
[#4478]: #4478
[#4430]: #4430
[#4457]: #4457
[#4459]: #4459
[#4449]: #4449
[#4462]: #4462
[#4436]: #4436
[#4480]: #4480
[#4271]: #4271
[#4491]: #4491
[#4397]: #4397
[#4479]: #4479
[#4483]: #4483
[#4335]: #4335
[#4475]: #4475
[#4453]: #4453
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ipetkov ipetkov ipetkov approved these changes

Assignees

@ipetkov ipetkov

Labels

A-tokio Area: The main tokio crate M-process Module: tokio/process T-docs Topic: documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

ChildStdin does not send EOF on .shutdown()

3 participants

@coral @ipetkov @Darksonn