big cleanup

Author: tobz

.vale/styles/config/vocabularies/technical/accept.txt

@@ -256,3 +256,4 @@ rss
 waker
 (non-?)?interruptible
 PR
+uninterrupible

lib/saluki-core/src/components/decoders/context.rs

@@ -43,36 +43,36 @@ impl DecoderContext {
         self.health_handle.take().expect("health handle already taken")
     }
 
-    /// Gets a reference to the topology context.
+    /// Returns a reference to the topology context.
     pub fn topology_context(&self) -> &TopologyContext {
         &self.topology_context
     }
 
-    /// Gets a reference to the component context.
+    /// Returns a reference to the component context.
     pub fn component_context(&self) -> &ComponentContext {
         &self.component_context
     }
 
-    /// Gets a reference to the component registry.
+    /// Returns a reference to the component registry.
     pub fn component_registry(&mut self) -> &ComponentRegistry {
         &self.component_registry
     }
 
-    /// Gets a reference to the events dispatcher.
+    /// Returns a reference to the events dispatcher.
     pub fn dispatcher(&self) -> &EventsDispatcher {
         &self.dispatcher
     }
 
-    /// Gets a mutable reference to the payloads consumer.
+    /// Returns a mutable reference to the payloads consumer.
     pub fn payloads(&mut self) -> &mut PayloadsConsumer {
         &mut self.consumer
     }
 
     /// Returns a spawner for supervised child tasks belonging to this component.
     ///
-    /// Children spawned through it have their lifecycle coupled to the component itself: if the
-    /// component restarts, or the component's supervisor dies, its children are terminated too.
-    pub fn spawn_handle(&self) -> &ComponentSpawner {
+    /// All child tasks spawned through this mechanism are tied to the lifecycle of the component itself, such that
+    /// they're automatically shutdown/stopped when the component is stopped during topology shutdown, etc.
+    pub fn spawner(&self) -> &ComponentSpawner {
         &self.spawner
     }
 }

lib/saluki-core/src/components/destinations/context.rs

@@ -34,38 +34,38 @@ impl DestinationContext {
 
     /// Consumes the health handle of this destination context.
     ///
-    /// ## Panics
+    /// # Panics
     ///
     /// Panics if the health handle has already been taken.
     pub fn take_health_handle(&mut self) -> Health {
         self.health_handle.take().expect("health handle already taken")
     }
 
-    /// Gets a reference to the topology context.
+    /// Returns a reference to the topology context.
     pub fn topology_context(&self) -> &TopologyContext {
         &self.topology_context
     }
 
-    /// Gets a reference to the component context.
+    /// Returns a reference to the component context.
     pub fn component_context(&self) -> &ComponentContext {
         &self.component_context
     }
 
-    /// Gets a reference to the component registry.
+    /// Returns a reference to the component registry.
     pub fn component_registry(&mut self) -> &ComponentRegistry {
         &self.component_registry
     }
 
-    /// Gets a mutable reference to the events consumer.
+    /// Returns a mutable reference to the events consumer.
     pub fn events(&mut self) -> &mut EventsConsumer {
         &mut self.consumer
     }
 
     /// Returns a spawner for supervised child tasks belonging to this component.
     ///
-    /// Children spawned through it have their lifecycle coupled to the component itself: if the
-    /// component restarts, or the component's supervisor dies, its children are terminated too.
-    pub fn spawn_handle(&self) -> &ComponentSpawner {
+    /// All child tasks spawned through this mechanism are tied to the lifecycle of the component itself, such that
+    /// they're automatically shutdown/stopped when the component is stopped during topology shutdown, etc.
+    pub fn spawner(&self) -> &ComponentSpawner {
         &self.spawner
     }
 }

lib/saluki-core/src/components/encoders/context.rs

@@ -43,36 +43,36 @@ impl EncoderContext {
         self.health_handle.take().expect("health handle already taken")
     }
 
-    /// Gets a reference to the topology context.
+    /// Returns a reference to the topology context.
     pub fn topology_context(&self) -> &TopologyContext {
         &self.topology_context
     }
 
-    /// Gets a reference to the component context.
+    /// Returns a reference to the component context.
     pub fn component_context(&self) -> &ComponentContext {
         &self.component_context
     }
 
-    /// Gets a reference to the component registry.
+    /// Returns a reference to the component registry.
     pub fn component_registry(&mut self) -> &ComponentRegistry {
         &self.component_registry
     }
 
-    /// Gets a reference to the payloads dispatcher.
+    /// Returns a reference to the payloads dispatcher.
     pub fn dispatcher(&self) -> &PayloadsDispatcher {
         &self.dispatcher
     }
 
-    /// Gets a mutable reference to the events consumer.
+    /// Returns a mutable reference to the events consumer.
     pub fn events(&mut self) -> &mut EventsConsumer {
         &mut self.consumer
     }
 
     /// Returns a spawner for supervised child tasks belonging to this component.
     ///
-    /// Children spawned through it have their lifecycle coupled to the component itself: if the
-    /// component restarts, or the component's supervisor dies, its children are terminated too.
-    pub fn spawn_handle(&self) -> &ComponentSpawner {
+    /// All child tasks spawned through this mechanism are tied to the lifecycle of the component itself, such that
+    /// they're automatically shutdown/stopped when the component is stopped during topology shutdown, etc.
+    pub fn spawner(&self) -> &ComponentSpawner {
         &self.spawner
     }
 }

lib/saluki-core/src/components/forwarders/context.rs

@@ -41,31 +41,31 @@ impl ForwarderContext {
         self.health_handle.take().expect("health handle already taken")
     }
 
-    /// Gets a reference to the topology context.
+    /// Returns a reference to the topology context.
     pub fn topology_context(&self) -> &TopologyContext {
         &self.topology_context
     }
 
-    /// Gets a reference to the component context.
+    /// Returns a reference to the component context.
     pub fn component_context(&self) -> &ComponentContext {
         &self.component_context
     }
 
-    /// Gets a reference to the component registry.
+    /// Returns a reference to the component registry.
     pub fn component_registry(&mut self) -> &ComponentRegistry {
         &self.component_registry
     }
 
-    /// Gets a mutable reference to the payloads consumer.
+    /// Returns a mutable reference to the payloads consumer.
     pub fn payloads(&mut self) -> &mut PayloadsConsumer {
         &mut self.consumer
     }
 
     /// Returns a spawner for supervised child tasks belonging to this component.
     ///
-    /// Children spawned through it have their lifecycle coupled to the component itself: if the
-    /// component restarts, or the component's supervisor dies, its children are terminated too.
-    pub fn spawn_handle(&self) -> &ComponentSpawner {
+    /// All child tasks spawned through this mechanism are tied to the lifecycle of the component itself, such that
+    /// they're automatically shutdown/stopped when the component is stopped during topology shutdown, etc.
+    pub fn spawner(&self) -> &ComponentSpawner {
         &self.spawner
     }
 }

lib/saluki-core/src/components/relays/context.rs

@@ -70,31 +70,31 @@ impl RelayContext {
         self.health_handle.take().expect("health handle already taken")
     }
 
-    /// Gets a reference to the topology context.
+    /// Returns a reference to the topology context.
     pub fn topology_context(&self) -> &TopologyContext {
         &self.inner.topology_context
     }
 
-    /// Gets a reference to the component context.
+    /// Returns a reference to the component context.
     pub fn component_context(&self) -> &ComponentContext {
         &self.inner.component_context
     }
 
-    /// Gets a reference to the component registry.
+    /// Returns a reference to the component registry.
     pub fn component_registry(&self) -> &ComponentRegistry {
         &self.inner.component_registry
     }
 
-    /// Gets a reference to the payloads dispatcher.
+    /// Returns a reference to the payloads dispatcher.
     pub fn dispatcher(&self) -> &PayloadsDispatcher {
         &self.inner.dispatcher
     }
 
     /// Returns a spawner for supervised child tasks belonging to this component.
     ///
-    /// Children spawned through it have their lifecycle coupled to the component itself: if the
-    /// component restarts, or the component's supervisor dies, its children are terminated too.
-    pub fn spawn_handle(&self) -> &ComponentSpawner {
+    /// All child tasks spawned through this mechanism are tied to the lifecycle of the component itself, such that
+    /// they're automatically shutdown/stopped when the component is stopped during topology shutdown, etc.
+    pub fn spawner(&self) -> &ComponentSpawner {
         &self.inner.spawner
     }
 }

lib/saluki-core/src/components/sources/context.rs

@@ -46,8 +46,8 @@ impl SourceContext {
 
     /// Installs the shutdown handle for this source context.
     ///
-    /// Called once by the runtime, before the component runs, with the shutdown signal of the
-    /// component's dedicated supervisor.
+    /// Called once by the runtime, before the component runs, with the shutdown signal of the component's dedicated
+    /// supervisor.
     pub(crate) fn set_shutdown_handle(&mut self, shutdown_handle: ShutdownHandle) {
         self.shutdown_handle = Some(shutdown_handle);
     }
@@ -70,31 +70,31 @@ impl SourceContext {
         self.health_handle.take().expect("health handle already taken")
     }
 
-    /// Gets a reference to the topology context.
+    /// Returns a reference to the topology context.
     pub fn topology_context(&self) -> &TopologyContext {
         &self.inner.topology_context
     }
 
-    /// Gets a reference to the component context.
+    /// Returns a reference to the component context.
     pub fn component_context(&self) -> &ComponentContext {
         &self.inner.component_context
     }
 
-    /// Gets a reference to the component registry.
+    /// Returns a reference to the component registry.
     pub fn component_registry(&self) -> &ComponentRegistry {
         &self.inner.component_registry
     }
 
-    /// Gets a reference to the events dispatcher.
+    /// Returns a reference to the events dispatcher.
     pub fn dispatcher(&self) -> &EventsDispatcher {
         &self.inner.dispatcher
     }
 
     /// Returns a spawner for supervised child tasks belonging to this component.
     ///
-    /// Children spawned through it have their lifecycle coupled to the component itself: if the
-    /// component restarts, or the component's supervisor dies, its children are terminated too.
-    pub fn spawn_handle(&self) -> &ComponentSpawner {
+    /// All child tasks spawned through this mechanism are tied to the lifecycle of the component itself, such that
+    /// they're automatically shutdown/stopped when the component is stopped during topology shutdown, etc.
+    pub fn spawner(&self) -> &ComponentSpawner {
         &self.inner.spawner
     }
 }