bucket_dl 0.4.0

A multithreaded downloader with the purpose of faster downloads by splitting it into several requests, rebuilding the data client-side.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

> [!Warning]
> This is still a work in progress. Yes there are issues, everything is okay.

# bucket_dl

![Tests](https://github.com/Pybounce/bucket_dl/actions/workflows/cargo_test.yml/badge.svg)
[![Latest version](https://img.shields.io/crates/v/bucket_dl.svg)](https://crates.io/crates/bucket_dl)

A multithreaded downloader with the purpose of faster downloads by splitting it into several requests, rebuilding the data client-side.

## Features

- [x] When possible, splits download into 'buckets', each using a new thread and request.
- [x] Streams live download progress, ideal for visualising loading bars.
- [x] Cancellation of downloads
- [ ] Retries failed buckets, creating a new thread/request up to x times.
- [ ] Supports pausing and resuming downloads at any time.
- [ ] Automatic pausing in the event of a crash.
- [ ] Actual tests

## Usage

> [!Note]
> For more detailed usage, look at the examples/ directory.

```rust
  let mut client = DownloadClient::init(&url, &file_path);

  if let Ok(_) = client.begin_download().await {
    let mut stream = client.progress_stream();
    while let Some(bucket_progress) = stream.next().await {...}

    match client.status() {
      DownloadStatus::Finished => {...},
      _ => {...}
    }

  }
```

> [!Warning]
> Always remember to check the status of the download, even after exhausting the progress updates.