refactor!: rename get_cancellation_token to cancellation_token (#153)

This makes the name consistent with the other accessor methods.
aschey · Feb 15, 2025 · cd13d91 · cd13d91
1 parent 4778348
commit cd13d91
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -424,8 +424,9 @@ impl<P: StorageProvider> StreamDownload<P> {
         self.download_task_cancellation_token.cancel();
     }
 
-    /// Get the [`CancellationToken`] for the download task.
-    pub fn get_cancellation_token(&self) -> CancellationToken {
+    /// Returns the [`CancellationToken`] for the download task.
+    /// This can be used to cancel the download task before it completes.
+    pub fn cancellation_token(&self) -> CancellationToken {
         self.download_task_cancellation_token.clone()
     }