Tracking Issue for anonymous pipe API

[NobodyXu]

This is a tracking issue for the ACP rust-lang/libs-team#375 .
The feature gate for the issue is #![feature(anonymous_pipe)].

// std::pipe

fn pipe() -> io::Result<(PipeReader, PipeWriter)>;

struct PipeReader {...}
struct PipeWriter {...}

impl PipeReader {
    fn try_clone(&self) -> io::Result<Self>;
}

impl PipeWriter {
    fn try_clone(&self) -> io::Result<Self>;
}

impl Read for &PipeReader
impl Read for PipeReader
impl Debug for PipeReader
impl From<PipeReader> for Stdio

impl Write for &PipeWriter
impl Write for PipeWriter
impl Debug for PipeWriter
impl From<PipeWriter> for Stdio

// unix {
impl AsFd for PipeReader
impl AsRawFd for PipeReader
impl FromRawFd for PipeReader
impl IntoRawFd for PipeReader
impl From<PipeReader> for OwnedFd
impl From<OwnedFd> for PipeReader

impl AsFd for PipeWriter
impl AsRawFd for PipeWriter
impl FromRawFd for PipeWriter
impl IntoRawFd for PipeWriter
impl From<PipeWriter> for OwnedFd
impl From<OwnedFd> for PipeWriter
// }

// windows {
impl AsHandle for PipeReader
impl AsRawHandle for PipeReader
impl FromRawHandle for PipeReader
impl IntoRawHandle for PipeReader
impl From<PipeReader> for OwnedHandle
impl From<OwnedHandle> for PipeReader

impl AsHandle for PipeWriter
impl AsRawHandle for PipeWriter
impl FromRawHandle for PipeWriter
impl IntoRawHandle for PipeWriter
impl From<PipeWriter> for OwnedHandle
impl From<OwnedHandle> for PipeWriter
// }

Steps

• Implement the ACP Initial implementation of anonymous_pipe API #127153
• Enable std::io::copy specialisation Enable std::io::copy specialisation for std::pipe::{PipeReader, PipeWriter} #128303
• Adjust documentation Add documentation for anonymous pipe module #133986 (see instructions on rustc-dev-guide)
• Stabilization PR (see instructions on rustc-dev-guide)

Implementation history

• Initial implementation of anonymous_pipe API #127153
• Enable std::io::copy specialisation for std::pipe::{PipeReader, PipeWriter} #128303

[Fulgen301]

You might want to fix the typo in the title and feature name - it's an anonymous pipe, not an annoymous pipe.

[NobodyXu]

Thanks!

I've fixed the typo in this issue and the linked PR.

[NobodyXu]

I think we can now add specialisation to std::io::copy for std::pipe

[NobodyXu]

I'm thinking about a new method for checked conversion from OwnedFd on unix.

I think it would be quite helpful for jobserver-rs

[RalfJung]

Currently the documentation for this module is very bare-bones, quite far from the depth and quality we are used to in other parts of the standard library. There's not even a single example. This should be resolved before stabilization.

[NobodyXu]

@olishmollie has added e examples and improve documentation in #133986, does it mean it can be stabilised @RalfJung

[RalfJung]

That's up for the team to decide. I have nominated this for team discussion to get them to take a look at this.

[joshtriplett]

I'm going to go ahead and start a stabilization FCP to collect consensus asynchronously, though we'll still talk about it in a meeting as well:

@rfcbot merge

[rfcbot]

Team member @joshtriplett has proposed to merge this. The next step is review by the rest of the tagged team members:

• @Amanieu
• @BurntSushi
• @dtolnay
• @joshtriplett
• @m-ou-se

No concerns currently listed.

Once a majority of reviewers approve (and at most 2 approvals are outstanding), this will enter its final comment period. If you spot a major issue that hasn't been raised at any point in this process, please speak up!

See this document for info about what commands tagged team members can give me.

[dtolnay]

I have added an API outline to the top of this issue. It is different from the one in the ACP.