From 9de8a4841f92352c23bf6dda247753808a65e6de Mon Sep 17 00:00:00 2001 From: Jiahao XU Date: Sat, 18 Jun 2022 18:12:48 +1000 Subject: [PATCH] Update doc of mod `async_extracter` Signed-off-by: Jiahao XU --- src/helpers/async_extracter.rs | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/src/helpers/async_extracter.rs b/src/helpers/async_extracter.rs index c2ff7800..634df7e0 100644 --- a/src/helpers/async_extracter.rs +++ b/src/helpers/async_extracter.rs @@ -1,14 +1,12 @@ //! # Advantages //! //! Using this mod has the following advantages over downloading -//! and extracting in on the async thread: +//! to file then extracting: //! //! - The code is pipelined instead of storing the downloaded file in memory //! and extract it, except for `PkgFmt::Zip`, since `ZipArchiver::new` //! requires `std::io::Seek`, so it fallbacks to writing the a file then //! unzip it. -//! - The async part (downloading) and the extracting part runs in parallel -//! using `tokio::spawn_nonblocking`. //! - Compressing/writing which takes a lot of CPU time will not block //! the runtime anymore. //! - For all `tar` based formats, it can extract only specified files and