Skip to content

Commit 452c86e

Browse files
Rollup merge of #76978 - duckymirror:mpsc-from-doc, r=jyn514
Documented From impls in std/sync/mpsc/mod.rs This is for #51430. r? @steveklabnik
2 parents d766c23 + 16eee2a commit 452c86e

File tree

1 file changed

+15
-0
lines changed
  • library/std/src/sync/mpsc

1 file changed

+15
-0
lines changed

library/std/src/sync/mpsc/mod.rs

+15
Original file line numberDiff line numberDiff line change
@@ -1531,6 +1531,11 @@ impl<T: Send> error::Error for TrySendError<T> {
15311531

15321532
#[stable(feature = "mpsc_error_conversions", since = "1.24.0")]
15331533
impl<T> From<SendError<T>> for TrySendError<T> {
1534+
/// Converts a `SendError<T>` into a `TrySendError<T>`.
1535+
///
1536+
/// This conversion always returns a `TrySendError::Disconnected` containing the data in the `SendError<T>`.
1537+
///
1538+
/// No data is allocated on the heap.
15341539
fn from(err: SendError<T>) -> TrySendError<T> {
15351540
match err {
15361541
SendError(t) => TrySendError::Disconnected(t),
@@ -1576,6 +1581,11 @@ impl error::Error for TryRecvError {
15761581

15771582
#[stable(feature = "mpsc_error_conversions", since = "1.24.0")]
15781583
impl From<RecvError> for TryRecvError {
1584+
/// Converts a `RecvError` into a `TryRecvError`.
1585+
///
1586+
/// This conversion always returns `TryRecvError::Disconnected`.
1587+
///
1588+
/// No data is allocated on the heap.
15791589
fn from(err: RecvError) -> TryRecvError {
15801590
match err {
15811591
RecvError => TryRecvError::Disconnected,
@@ -1606,6 +1616,11 @@ impl error::Error for RecvTimeoutError {
16061616

16071617
#[stable(feature = "mpsc_error_conversions", since = "1.24.0")]
16081618
impl From<RecvError> for RecvTimeoutError {
1619+
/// Converts a `RecvError` into a `RecvTimeoutError`.
1620+
///
1621+
/// This conversion always returns `RecvTimeoutError::Disconnected`.
1622+
///
1623+
/// No data is allocated on the heap.
16091624
fn from(err: RecvError) -> RecvTimeoutError {
16101625
match err {
16111626
RecvError => RecvTimeoutError::Disconnected,

0 commit comments

Comments
 (0)