@@ -179,11 +179,11 @@ pub struct MessageHandler<CM: Deref, RM: Deref> where
179
179
/// For efficiency, Clone should be relatively cheap for this type.
180
180
///
181
181
/// Two descriptors may compare equal (by [`cmp::Eq`] and [`hash::Hash`]) as long as the original
182
- /// has been disconnected, the [`PeerManager`] informed of the disconnection (either by it having
183
- /// triggered the disconnection or a call to [`PeerManager::socket_disconnected`]), and no further
184
- /// calls to the [`PeerManager`] related to the original socket occur. This allows you to use a
185
- /// file descriptor for your SocketDescriptor directly, however for simplicity you may wish to
186
- /// simply use another value which is guaranteed to be globally unique instead.
182
+ /// has been disconnected, the [`PeerManager`] has been informed of the disconnection (either by it
183
+ /// having triggered the disconnection or a call to [`PeerManager::socket_disconnected`]), and no
184
+ /// further calls to the [`PeerManager`] related to the original socket occur. This allows you to
185
+ /// use a file descriptor for your SocketDescriptor directly, however for simplicity you may wish
186
+ /// to simply use another value which is guaranteed to be globally unique instead.
187
187
pub trait SocketDescriptor : cmp:: Eq + hash:: Hash + Clone {
188
188
/// Attempts to send some data from the given slice to the peer.
189
189
///
@@ -628,10 +628,10 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref> PeerManager<D
628
628
///
629
629
/// May return an Err to indicate that the connection should be closed.
630
630
///
631
- /// May call [`send_data`] on the descriptor passed in (or another provided descriptor) before
631
+ /// May call [`send_data`] on the descriptor passed in (or an equal descriptor) before
632
632
/// returning. Thus, be very careful with reentrancy issues! The invariants around calling
633
633
/// [`write_buffer_space_avail`] in case a write did not fully complete must still hold - be
634
- /// ready to call `[write_buffer_space_avail`] again if a write call generated here isnt'
634
+ /// ready to call `[write_buffer_space_avail`] again if a write call generated here isn't
635
635
/// sufficient!
636
636
///
637
637
/// [`send_data`]: SocketDescriptor::send_data
@@ -1381,7 +1381,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref> PeerManager<D
1381
1381
/// It will send pings to each peer and disconnect those which did not respond to the last
1382
1382
/// round of pings.
1383
1383
///
1384
- /// May call [`send_data`] all [`SocketDescriptor`]s. Thus, be very careful with reentrancy
1384
+ /// May call [`send_data`] on all [`SocketDescriptor`]s. Thus, be very careful with reentrancy
1385
1385
/// issues!
1386
1386
///
1387
1387
/// [`send_data`]: SocketDescriptor::send_data
0 commit comments