jleony/nanoreth
1
0
Fork 0
mirror of https://github.com/hl-archive-node/nanoreth.git synced 2025-12-06 10:59:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

add doc_markdown clippy lint (#8552)

Browse Source 
Co-authored-by: Alexey Shekhirin <a.shekhirin@gmail.com>
Co-authored-by: Matthias Seitz <matthias.seitz@outlook.de>
This commit is contained in:
Thomas Coratger
2024-06-03 15:21:45 +02:00
committed by GitHub
parent 34af610b8e
commit 7c17c6e469
440 changed files with 2166 additions and 2145 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
crates/net/network-api/src/lib.rs
View File

@ -21,7 +21,7 @@ pub use error::NetworkError;
pub use reputation::{Reputation, ReputationChangeKind};
use reth_network_types::NodeRecord;
/// The PeerId type.
/// The `PeerId` type.
pub type PeerId = alloy_primitives::B512;
/// Network Error
@ -71,7 +71,7 @@ pub trait Peers: PeersInfo {
self.add_peer_kind(peer, PeerKind::Basic, addr);
}
/// Adds a trusted [PeerId] to the peer set.
/// Adds a trusted [`PeerId`] to the peer set.
///
/// This allows marking a peer as trusted without having to know the peer's address.
fn add_trusted_peer_id(&self, peer: PeerId);
@ -84,28 +84,28 @@ pub trait Peers: PeersInfo {
/// Adds a peer to the known peer set, with the given kind.
fn add_peer_kind(&self, peer: PeerId, kind: PeerKind, addr: SocketAddr);
/// Returns the rpc [PeerInfo] for all connected [PeerKind::Trusted] peers.
/// Returns the rpc [`PeerInfo`] for all connected [`PeerKind::Trusted`] peers.
fn get_trusted_peers(
&self,
) -> impl Future<Output = Result<Vec<PeerInfo>, NetworkError>> + Send {
self.get_peers_by_kind(PeerKind::Trusted)
}
/// Returns the rpc [PeerInfo] for all connected [PeerKind::Basic] peers.
/// Returns the rpc [`PeerInfo`] for all connected [`PeerKind::Basic`] peers.
fn get_basic_peers(&self) -> impl Future<Output = Result<Vec<PeerInfo>, NetworkError>> + Send {
self.get_peers_by_kind(PeerKind::Basic)
}
/// Returns the rpc [PeerInfo] for all connected peers with the given kind.
/// Returns the rpc [`PeerInfo`] for all connected peers with the given kind.
fn get_peers_by_kind(
&self,
kind: PeerKind,
) -> impl Future<Output = Result<Vec<PeerInfo>, NetworkError>> + Send;
/// Returns the rpc [PeerInfo] for all connected peers.
/// Returns the rpc [`PeerInfo`] for all connected peers.
fn get_all_peers(&self) -> impl Future<Output = Result<Vec<PeerInfo>, NetworkError>> + Send;
/// Returns the rpc [PeerInfo] for the given peer id.
/// Returns the rpc [`PeerInfo`] for the given peer id.
///
/// Returns `None` if the peer is not connected.
fn get_peer_by_id(
@ -113,7 +113,7 @@ pub trait Peers: PeersInfo {
peer_id: PeerId,
) -> impl Future<Output = Result<Option<PeerInfo>, NetworkError>> + Send;
/// Returns the rpc [PeerInfo] for the given peers if they are connected.
/// Returns the rpc [`PeerInfo`] for the given peers if they are connected.
///
/// Note: This only returns peers that are connected, unconnected peers are ignored but keeping
/// the order in which they were requested.

4
crates/net/network-api/src/reputation.rs
View File

@ -40,12 +40,12 @@ pub enum ReputationChangeKind {
}
impl ReputationChangeKind {
/// Returns true if the reputation change is a [ReputationChangeKind::Reset].
/// Returns true if the reputation change is a [`ReputationChangeKind::Reset`].
pub const fn is_reset(&self) -> bool {
matches!(self, Self::Reset)
}
/// Returns true if the reputation change is [ReputationChangeKind::Dropped].
/// Returns true if the reputation change is [`ReputationChangeKind::Dropped`].
pub const fn is_dropped(&self) -> bool {
matches!(self, Self::Dropped)
}