diff --git a/protocols/gossipsub/src/behaviour.rs b/protocols/gossipsub/src/behaviour.rs index 82dc3469e73..900e1b43be4 100644 --- a/protocols/gossipsub/src/behaviour.rs +++ b/protocols/gossipsub/src/behaviour.rs @@ -3335,7 +3335,7 @@ where )); } else if let Some(conn) = self.connected_peers.get_mut(&propagation_source) { // Only change the value if the old value is Floodsub (the default set in - // inject_connected). All other PeerKind changes are ignored. + // inject_connection_established). All other PeerKind changes are ignored. debug!( "New peer type found: {} for peer: {}", kind, propagation_source diff --git a/swarm/src/behaviour.rs b/swarm/src/behaviour.rs index 7ab54c73c05..d6802c086a8 100644 --- a/swarm/src/behaviour.rs +++ b/swarm/src/behaviour.rs @@ -205,8 +205,7 @@ pub trait NetworkBehaviour: 'static { /// Informs the behaviour about a closed connection to a peer. /// /// A call to this method is always paired with an earlier call to - /// `inject_connection_established` with the same peer ID, connection ID and - /// endpoint. + /// [`NetworkBehaviour::inject_connection_established`] with the same peer ID, connection ID and endpoint. fn inject_connection_closed( &mut self, _: &PeerId, @@ -230,8 +229,8 @@ pub trait NetworkBehaviour: 'static { /// Informs the behaviour about an event generated by the handler dedicated to the peer identified by `peer_id`. /// for the behaviour. /// - /// The `peer_id` is guaranteed to be in a connected state. In other words, `inject_connected` - /// has previously been called with this `PeerId`. + /// The `peer_id` is guaranteed to be in a connected state. In other words, + /// [`NetworkBehaviour::inject_connection_established`] has previously been called with this `PeerId`. fn inject_event( &mut self, peer_id: PeerId, diff --git a/swarm/src/lib.rs b/swarm/src/lib.rs index f32c2df56bf..74de015a858 100644 --- a/swarm/src/lib.rs +++ b/swarm/src/lib.rs @@ -1701,13 +1701,12 @@ mod tests { /// after which one peer bans the other. /// /// The test expects both behaviours to be notified via pairs of - /// inject_connected / inject_disconnected as well as - /// inject_connection_established / inject_connection_closed calls - /// while unbanned. + /// [`NetworkBehaviour::inject_connection_established`] / [`NetworkBehaviour::inject_connection_closed`] + /// calls while unbanned. /// /// While the ban is in effect, further dials occur. For these connections no - /// `inject_connected`, `inject_connection_established`, `inject_disconnected`, - /// `inject_connection_closed` calls should be registered. + /// [`NetworkBehaviour::inject_connection_established`], [`NetworkBehaviour::inject_connection_closed`] + /// calls should be registered. #[test] fn test_connect_disconnect_ban() { // Since the test does not try to open any substreams, we can @@ -1827,8 +1826,7 @@ mod tests { /// after which one peer disconnects the other using [`Swarm::disconnect_peer_id`]. /// /// The test expects both behaviours to be notified via pairs of - /// inject_connected / inject_disconnected as well as - /// inject_connection_established / inject_connection_closed calls. + /// [`NetworkBehaviour::inject_connection_established`] / [`NetworkBehaviour::inject_connection_closed`] calls. #[test] fn test_swarm_disconnect() { // Since the test does not try to open any substreams, we can @@ -1896,8 +1894,7 @@ mod tests { /// using [`NetworkBehaviourAction::CloseConnection`] returned by a [`NetworkBehaviour`]. /// /// The test expects both behaviours to be notified via pairs of - /// inject_connected / inject_disconnected as well as - /// inject_connection_established / inject_connection_closed calls. + /// [`NetworkBehaviour::inject_connection_established`] / [`NetworkBehaviour::inject_connection_closed`] calls. #[test] fn test_behaviour_disconnect_all() { // Since the test does not try to open any substreams, we can @@ -1967,8 +1964,7 @@ mod tests { /// using [`NetworkBehaviourAction::CloseConnection`] returned by a [`NetworkBehaviour`]. /// /// The test expects both behaviours to be notified via pairs of - /// inject_connected / inject_disconnected as well as - /// inject_connection_established / inject_connection_closed calls. + /// [`NetworkBehaviour::inject_connection_established`] / [`NetworkBehaviour::inject_connection_closed`] calls. #[test] fn test_behaviour_disconnect_one() { // Since the test does not try to open any substreams, we can