StapledStream is a weird name

[jtrakk]

And in my mental picture of two streams, stapling them together chokes both of them off. Why not BidirectionalStream or TwoWayStream? BidiStream is also available, though I wouldn't personally advocate for an abbreviation.

[njsmith]

All Streams are bidirectional, by definition. And most Stream implementations get this automatically, e.g. a SocketStream wraps around a TCP socket, and TCP sockets are already bidirectional. The key thing for StapledStream isn't that it's bidirectional, but that it helps you in the situation where you've somehow ended up with two unidirectional streams and need to make the jump to bidirectional, so I think the name should emphasize that jump.

The name is a bit cutesy though, yeah. I dunno that like, GluedStream would be any better though :-). Any other ideas?

[jtrakk]

Any other ideas?

• DualStream
• BidirectionalStream
• BidiStream
• TwoWayStream
• DuplexStream
• MergedStream
• ParallelStream
• Stream

[njsmith]

Hmm. For some of those I wonder if people could misread them as referring to somehow merging together the contents of two streams. Like MergedStream might be:

But it could also be:

I don't think we need to move quickly here, especially with #1208 still under discussion, so I'm going to leave this open for now to collect any thoughts folks have. And I added the "potential API breaker" label, to make sure that we remember to make a decision before v1.0.

[agronholm]

I feel that all those alternatives are misleading and StapledStream matches more closely to what is being done there.

[parity3]

I'll add another name just for fun: CompositeStream

[tapple]

as a newbie, I was looking for a way to route an output stream to an input stream, and I thought StapledStream would do that, since I assume it's a very common task, and I saw nothing else that looked close. But then I found out it doesn't do that