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

Fuse type in tokio::stream::StreamExt is not hyperlinked and not searchable #2187

Closed
osa1 opened this issue Jan 28, 2020 · 3 comments
Closed

Comments

@osa1
Copy link
Contributor

osa1 commented Jan 28, 2020

This happens all the time (in different crates too) and it really bothers me. I'm looking at documentation of StreamExt::fuse. It returns a type called Fuse, but I can't see what that is. The type is not hyperlinked, and searching for it doesn't yield any results.

Only way to get any information about it is to look at the source code.

I think types mentioned by public API functions/methods should be public, otherwise I end up getting some internal type that I don't know what it is for or how to use it.

@osa1
Copy link
Contributor Author

osa1 commented Jan 28, 2020

Maybe I'm doing this wrong, but not exposing Fuse type is also making passing fuse()d stuff around in function arguments impossible.

@carllerche
Copy link
Member

Ah, it's because the type is not re-exported as part of the public API.

I think that we can safely export types that implement Stream.

@Darksonn
Copy link
Contributor

Closing in favor of #2188.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants