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.

Sign up for GitHub

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

Jump to bottom

Documentation phrase about panics in mpsc channel may be obsolete #37915

Closed
vi opened this issue Nov 21, 2016 · 1 comment · Fixed by #37941
Closed

Documentation phrase about panics in mpsc channel may be obsolete #37915

vi opened this issue Nov 21, 2016 · 1 comment · Fixed by #37941

Comments

@vi
Copy link
Contributor

vi commented Nov 21, 2016

https://doc.rust-lang.org/std/sync/mpsc/fn.sync_channel.html#main

As with asynchronous channels, all senders will panic in send if the Receiver has been destroyed.

https://doc.rust-lang.org/std/sync/mpsc/struct.SyncSender.html#send.v

This function will never panic, but it may return Err if the Receiver has disconnected and is no longer able to receive information.
@Cobrand
Copy link
Contributor

Cobrand commented Nov 22, 2016

I will take care of this if no one minds

@Cobrand Cobrand mentioned this issue Nov 22, 2016
Merged
Cobrand added a commit to Cobrand/rust that referenced this issue Dec 7, 2016
@Cobrand
Improve and fix mpsc documentation
57f998a 
Closes rust-lang#37915

This commit enhances documentation with several links and
fixes an error in the `sync_channel` documentation as well:
`send` doesn't panic when the senders are all disconnected
frewsxcv added a commit to frewsxcv/rust that referenced this issue Dec 12, 2016
@frewsxcv
Rollup merge of rust-lang#37941 - Cobrand:docfix-issue-37915, r=Guill…
0b815c2 
…aumeGomez

Improve and fix mpsc documentation

Closes rust-lang#37915

This commit enhances documentation with several links and
fixes an error in the `sync_channel` documentation as well:
`send` doesn't panic when the senders are all disconnected

r? @steveklabnik
frewsxcv added a commit to frewsxcv/rust that referenced this issue Dec 12, 2016
@frewsxcv
Rollup merge of rust-lang#37941 - Cobrand:docfix-issue-37915, r=Guill…
8c3c9c2 
…aumeGomez

Improve and fix mpsc documentation

Closes rust-lang#37915

This commit enhances documentation with several links and
fixes an error in the `sync_channel` documentation as well:
`send` doesn't panic when the senders are all disconnected

r? @steveklabnik
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improve and fix mpsc documentation Cobrand/rust
3 participants
@steveklabnik @vi @Cobrand