f - fix rustdocs

Author: jkczyz

fuzz/src/full_stack.rs

@@ -382,7 +382,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
 	let our_id = PublicKey::from_secret_key(&Secp256k1::signing_only(), &keys_manager.get_node_secret());
 	let network_graph = NetworkGraph::new(genesis_block(network).block_hash());
 	let net_graph_msg_handler = Arc::new(NetGraphMsgHandler::new(network_graph, None, Arc::clone(&logger)));
-	let scorer = Scorer::<std::time::Instant>::with_fixed_penalty(0);
+	let scorer = Scorer::with_fixed_penalty(0);
 
 	let peers = RefCell::new([false; 256]);
 	let mut loss_detector = MoneyLossDetector::new(&peers, channelmanager.clone(), monitor.clone(), PeerManager::new(MessageHandler {

fuzz/src/router.rs

@@ -248,7 +248,7 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 						}]));
 					}
 				}
-				let scorer = Scorer::<std::time::Instant>::with_fixed_penalty(0);
+				let scorer = Scorer::with_fixed_penalty(0);
 				for target in node_pks.iter() {
 					let params = RouteParameters {
 						payee: Payee::new(*target).with_route_hints(last_hops.clone()),

lightning/src/ln/channelmanager.rs

@@ -6602,7 +6602,7 @@ pub mod bench {
 				let usable_channels = $node_a.list_usable_channels();
 				let payee = Payee::new($node_b.get_our_node_id())
 					.with_features(InvoiceFeatures::known());
-				let scorer = Scorer::<std::time::Instant>::with_fixed_penalty(0);
+				let scorer = Scorer::with_fixed_penalty(0);
 				let route = get_route(&$node_a.get_our_node_id(), &payee, &dummy_graph,
 					Some(&usable_channels.iter().map(|r| r).collect::<Vec<_>>()), 10_000, TEST_FINAL_CLTV, &logger_a, &scorer).unwrap();
 

lightning/src/routing/router.rs

@@ -4785,7 +4785,7 @@ mod benches {
 		let mut d = test_utils::get_route_file().unwrap();
 		let graph = NetworkGraph::read(&mut d).unwrap();
 		let nodes = graph.read_only().nodes().clone();
-		let scorer = Scorer::<std::time::Instant>::with_fixed_penalty(0);
+		let scorer = Scorer::with_fixed_penalty(0);
 
 		// First, get 100 (source, destination) pairs for which route-getting actually succeeds...
 		let mut path_endpoints = Vec::new();
@@ -4820,7 +4820,7 @@ mod benches {
 		let mut d = test_utils::get_route_file().unwrap();
 		let graph = NetworkGraph::read(&mut d).unwrap();
 		let nodes = graph.read_only().nodes().clone();
-		let scorer = Scorer::<std::time::Instant>::with_fixed_penalty(0);
+		let scorer = Scorer::with_fixed_penalty(0);
 
 		// First, get 100 (source, destination) pairs for which route-getting actually succeeds...
 		let mut path_endpoints = Vec::new();

lightning/src/routing/scorer.rs

@@ -31,10 +31,10 @@
 //! # let logger = FakeLogger {};
 //! #
 //! // Use the default channel penalties.
-//! let scorer = Scorer::<std::time::Instant>::default();
+//! let scorer = Scorer::default();
 //!
 //! // Or use custom channel penalties.
-//! let scorer = Scorer::<std::time::Instant>::new(ScoringParameters {
+//! let scorer = Scorer::new(ScoringParameters {
 //!     base_penalty_msat: 1000,
 //!     failure_penalty_msat: 2 * 1024 * 1000,
 //!     ..ScoringParameters::default()
@@ -62,7 +62,20 @@ use core::time::Duration;
 /// See [module-level documentation] for usage.
 ///
 /// [module-level documentation]: crate::routing::scorer
-pub struct Scorer<C: Clock> {
+pub type Scorer = ScorerUsingClock::<DefaultClock>;
+
+/// Clock used by [`Scorer`].
+#[cfg(not(feature = "no-std"))]
+pub type DefaultClock = std::time::Instant;
+
+/// Clock used by [`Scorer`].
+#[cfg(feature = "no-std")]
+pub type DefaultClock = AlwaysPresent;
+
+/// [`routing::Score`] implementation parameterized by a [`Clock`].
+///
+/// See [`Scorer`] for details.
+pub struct ScorerUsingClock<C: Clock> {
 	params: ScoringParameters,
 	channel_failures: HashMap<u64, ChannelFailure<C>>,
 }
@@ -103,7 +116,7 @@ pub trait Clock {
 	fn elapsed(&self) -> Duration;
 }
 
-impl<C: Clock> Scorer<C> {
+impl<C: Clock> ScorerUsingClock<C> {
 	/// Creates a new scorer using the given scoring parameters.
 	pub fn new(params: ScoringParameters) -> Self {
 		Self {
@@ -145,9 +158,9 @@ impl<C: Clock> ChannelFailure<C> {
 	}
 }
 
-impl<C: Clock> Default for Scorer<C> {
+impl<C: Clock> Default for ScorerUsingClock<C> {
 	fn default() -> Self {
-		Scorer::new(ScoringParameters::default())
+		Self::new(ScoringParameters::default())
 	}
 }
 
@@ -161,7 +174,7 @@ impl Default for ScoringParameters {
 	}
 }
 
-impl<C: Clock> routing::Score for Scorer<C> {
+impl<C: Clock> routing::Score for ScorerUsingClock<C> {
 	fn channel_penalty_msat(
 		&self, short_channel_id: u64, _source: &NodeId, _target: &NodeId
 	) -> u64 {

lightning/src/util/test_utils.rs

@@ -21,7 +21,7 @@ use ln::features::{ChannelFeatures, InitFeatures};
 use ln::msgs;
 use ln::msgs::OptionalField;
 use ln::script::ShutdownScript;
-use routing::scorer::{AlwaysPresent, Scorer};
+use routing::scorer::{AlwaysPresent, ScorerUsingClock};
 use util::enforcing_trait_impls::{EnforcingSigner, EnforcementState};
 use util::events;
 use util::logger::{Logger, Level, Record};
@@ -696,4 +696,4 @@ impl core::fmt::Debug for OnRegisterOutput {
 }
 
 /// A scorer useful in testing, when the passage of time isn't a concern.
-pub type TestScorer = Scorer<AlwaysPresent>;
+pub type TestScorer = ScorerUsingClock<AlwaysPresent>;