Rename Stop -> Cancel and related interfaces.

Retain backwards compatibility with appropriate aliases.

Author: ioquatix

lib/async/barrier.rb

@@ -88,14 +88,20 @@ def wait
 			end
 		end
 
-		# Stop all tasks held by the barrier.
+		# Cancel all tasks held by the barrier.
 		# @asynchronous May wait for tasks to finish executing.
-		def stop
+		def cancel
 			@tasks.each do |waiting|
-				waiting.task.stop
+				waiting.task.cancel
 			end
 
 			@finished.close
 		end
+		
+		# Backward compatibility alias for {#cancel}.
+		# @deprecated Use {#cancel} instead.
+		def stop
+			cancel
+		end
 	end
 end

lib/async/cancel.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+module Async
+	# Raised when a task is explicitly cancelled.
+	class Cancel < Exception
+		# Represents the source of the cancel operation.
+		class Cause < Exception
+			if RUBY_VERSION >= "3.4"
+				# @returns [Array(Thread::Backtrace::Location)] The backtrace of the caller.
+				def self.backtrace
+					caller_locations(2..-1)
+				end
+			else
+				# @returns [Array(String)] The backtrace of the caller.
+				def self.backtrace
+					caller(2..-1)
+				end
+			end
+			
+			# Create a new cause of the cancel operation, with the given message.
+			#
+			# @parameter message [String] The error message.
+			# @returns [Cause] The cause of the cancel operation.
+			def self.for(message = "Task was cancelled!")
+				instance = self.new(message)
+				instance.set_backtrace(self.backtrace)
+				return instance
+			end
+		end
+		
+		if RUBY_VERSION < "3.5"
+			# Create a new cancel operation.
+			#
+			# This is a compatibility method for Ruby versions before 3.5 where cause is not propagated correctly when using {Fiber#raise}
+			#
+			# @parameter message [String | Hash] The error message or a hash containing the cause.
+			def initialize(message = "Task was cancelled")
+				
+				if message.is_a?(Hash)
+					@cause = message[:cause]
+					message = "Task was cancelled"
+				end
+				
+				super(message)
+			end
+			
+			# @returns [Exception] The cause of the cancel operation.
+			#
+			# This is a compatibility method for Ruby versions before 3.5 where cause is not propagated correctly when using {Fiber#raise}, we explicitly capture the cause here.
+			def cause
+				super || @cause
+			end
+		end
+		
+		# Used to defer cancelling the current task until later.
+		class Later
+			# Create a new cancel later operation.
+			#
+			# @parameter task [Task] The task to cancel later.
+			# @parameter cause [Exception] The cause of the cancel operation.
+			def initialize(task, cause = nil)
+				@task = task
+				@cause = cause
+			end
+			
+			# @returns [Boolean] Whether the task is alive.
+			def alive?
+				true
+			end
+			
+			# Transfer control to the operation - this will cancel the task.
+			def transfer
+				@task.cancel(false, cause: @cause)
+			end
+		end
+	end
+end

lib/async/node.rb

@@ -280,18 +280,24 @@ def terminate
 			return @children.nil?
 		end
 
-		# Attempt to stop the current node immediately, including all non-transient children. Invokes {#stop_children} to stop all children.
+		# Attempt to cancel the current node immediately, including all non-transient children. Invokes {#stop_children} to cancel all children.
 		#
-		# @parameter later [Boolean] Whether to defer stopping until some point in the future.
-		def stop(later = false)
+		# @parameter later [Boolean] Whether to defer cancelling until some point in the future.
+		def cancel(later = false)
 			# The implementation of this method may defer calling `stop_children`.
 			stop_children(later)
 		end
 
+		# Backward compatibility alias for {#cancel}.
+		# @deprecated Use {#cancel} instead.
+		def stop(...)
+			cancel(...)
+		end
+		
 		# Attempt to stop all non-transient children.
 		private def stop_children(later = false)
 			@children&.each do |child|
-				child.stop(later) unless child.transient?
+				child.cancel(later) unless child.transient?
 			end
 		end
 
@@ -301,11 +307,17 @@ def wait
 			nil
 		end
 
-		# Whether the node has been stopped.
-		def stopped?
+		# Whether the node has been cancelled.
+		def cancelled?
 			@children.nil?
 		end
 
+		# Backward compatibility alias for {#cancelled?}.
+		# @deprecated Use {#cancelled?} instead.
+		def stopped?
+			cancelled?
+		end
+		
 		# Print the hierarchy of the task tree from the given node.
 		#
 		# @parameter out [IO] The output stream to write to.

lib/async/scheduler.rb

@@ -179,7 +179,7 @@ def closed?
 
 		# @returns [String] A description of the scheduler.
 		def to_s
-			"\#<#{self.description} #{@children&.size || 0} children (#{stopped? ? 'stopped' : 'running'})>"
+			"\#<#{self.description} #{@children&.size || 0} children (#{cancelled? ? 'cancelled' : 'running'})>"
 		end
 
 		# Interrupt the event loop and cause it to exit.
@@ -511,15 +511,20 @@ def run_once(timeout = nil)
 			return false
 		end
 
-		# Stop all children, including transient children.
+		# Cancel all children, including transient children.
 		#
 		# @public Since *Async v1*.
-		def stop
+		def cancel
 			@children&.each do |child|
-				child.stop
+				child.cancel
 			end
 		end
 
+		# Backward compatibility alias for cancel.
+		def stop
+			cancel
+		end
+		
 		private def run_loop(&block)
 			interrupt = nil
 

lib/async/stop.rb

@@ -1,82 +1,10 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2025, by Samuel Williams.
+# Copyright, 2025-2026, by Samuel Williams.
 
-require "fiber"
-require "console"
+require_relative "cancel"
 
 module Async
-	# Raised when a task is explicitly stopped.
-	class Stop < Exception
-		# Represents the source of the stop operation.
-		class Cause < Exception
-			if RUBY_VERSION >= "3.4"
-				# @returns [Array(Thread::Backtrace::Location)] The backtrace of the caller.
-				def self.backtrace
-					caller_locations(2..-1)
-				end
-			else
-				# @returns [Array(String)] The backtrace of the caller.
-				def self.backtrace
-					caller(2..-1)
-				end
-			end
-			
-			# Create a new cause of the stop operation, with the given message.
-			#
-			# @parameter message [String] The error message.
-			# @returns [Cause] The cause of the stop operation.
-			def self.for(message = "Task was stopped")
-				instance = self.new(message)
-				instance.set_backtrace(self.backtrace)
-				return instance
-			end
-		end
-		
-		if RUBY_VERSION < "3.5"
-			# Create a new stop operation.
-			#
-			# This is a compatibility method for Ruby versions before 3.5 where cause is not propagated correctly when using {Fiber#raise}
-			#
-			# @parameter message [String | Hash] The error message or a hash containing the cause.
-			def initialize(message = "Task was stopped")
-				if message.is_a?(Hash)
-					@cause = message[:cause]
-					message = "Task was stopped"
-				end
-				
-				super(message)
-			end
-			
-			# @returns [Exception] The cause of the stop operation.
-			#
-			# This is a compatibility method for Ruby versions before 3.5 where cause is not propagated correctly when using {Fiber#raise}, we explicitly capture the cause here.
-			def cause
-				super || @cause
-			end
-		end
-		
-		# Used to defer stopping the current task until later.
-		class Later
-			# Create a new stop later operation.
-			#
-			# @parameter task [Task] The task to stop later.
-			# @parameter cause [Exception] The cause of the stop operation.
-			def initialize(task, cause = nil)
-				@task = task
-				@cause = cause
-			end
-			
-			# @returns [Boolean] Whether the task is alive.
-			def alive?
-				true
-			end
-			
-			# Transfer control to the operation - this will stop the task.
-			def transfer
-				@task.stop(false, cause: @cause)
-			end
-		end
-	end
+	Stop = Cancel
 end