From e62775a9ecb31fa8f7b8cfb687198864617ddc69 Mon Sep 17 00:00:00 2001
From: Jiahao XU <Jiahao_XU@outlook.com>
Date: Thu, 9 Jun 2022 21:34:07 +1000
Subject: [PATCH] Add more doc for `AsyncFileWriter`

Signed-off-by: Jiahao XU <Jiahao_XU@outlook.com>
---
 src/helpers/async_file_writer.rs | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/helpers/async_file_writer.rs b/src/helpers/async_file_writer.rs
index 755cde72..53a61ceb 100644
--- a/src/helpers/async_file_writer.rs
+++ b/src/helpers/async_file_writer.rs
@@ -148,6 +148,11 @@ impl AsyncFileWriterInner {
     }
 }
 
+/// AsyncFileWriter will pass the `Bytes` you give to another thread via
+/// a `mpsc` and decompress and unpack it if needed.
+///
+/// # Cancellation
+///
 /// AsyncFileWriter removes the file if `done` isn't called.
 #[derive(Debug)]
 pub struct AsyncFileWriter(ScopeGuard<AsyncFileWriterInner, fn(AsyncFileWriterInner), Always>);