File tree Expand file tree Collapse file tree 1 file changed +9
-6
lines changed Expand file tree Collapse file tree 1 file changed +9
-6
lines changed Original file line number Diff line number Diff line change 88// licenses.
99
1010//! A socket handling library for those running in Tokio environments who wish to use
11- //! rust-lightning with native TcpStreams .
11+ //! rust-lightning with native [`TcpStream`]s .
1212//!
1313//! Designed to be as simple as possible, the high-level usage is almost as simple as "hand over a
14- //! TcpStream and a reference to a PeerManager and the rest is handled".
14+ //! [` TcpStream`] and a reference to a [` PeerManager`] and the rest is handled".
1515//!
16- //! The PeerHandler, due to the fire-and-forget nature of this logic, must be a reference, (e.g. an
17- //! `Arc`) and must use the SocketDescriptor provided here as the PeerHandler's SocketDescriptor.
16+ //! The [`PeerManager`], due to the fire-and-forget nature of this logic, must be a reference,
17+ //! (e.g. an [`Arc`]) and must use the [`SocketDescriptor`] provided here as the [`PeerManager`]'s
18+ //! `SocketDescriptor` implementation.
1819//!
19- //! Three methods are exposed to register a new connection for handling in tokio::spawn calls; see
20- //! their individual docs for details.
20+ //! Three methods are exposed to register a new connection for handling in [`tokio::spawn`] calls;
21+ //! see their individual docs for details.
22+ //!
23+ //! [`PeerManager`]: lightning::ln::peer_handler::PeerManager
2124
2225// Prefix these with `rustdoc::` when we update our MSRV to be >= 1.52 to remove warnings.
2326#![ deny( broken_intra_doc_links) ]
You can’t perform that action at this time.
0 commit comments