fast-down-api 0.1.1

A convenient and easy-to-use FFI wrapper for fast-down
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

#![doc = include_str!("../README.md")]

mod config;
mod core;
mod event;
pub(crate) mod utils;

pub use config::*;
pub use core::*;
pub use event::*;

pub use fast_down;

pub use tokio_util::sync::CancellationToken;

/// Sender half of the event channel, used to push [`Event`]s from the download task.
pub type Tx = crossfire::MTx<crossfire::mpmc::List<Event>>;
/// Receiver half of the event channel, used to receive [`Event`]s from the download task.
pub type Rx = crossfire::MAsyncRx<crossfire::mpmc::List<Event>>;

/// Create a new unbounded event channel for receiving download progress events.
///
/// Returns a sender (`Tx`) and receiver (`Rx`) pair.
#[must_use]
pub fn create_channel() -> (Tx, Rx) {
    crossfire::mpmc::unbounded_async()
}

/// Create a new [`CancellationToken`] for cooperative cancellation of a download.
///
/// Pass the returned token to [`download`] (or a related entry
/// point) and call
/// [`CancellationToken::cancel`](tokio_util::sync::CancellationToken::cancel) to
/// abort the in-flight download.
#[must_use]
pub fn create_cancellation_token() -> CancellationToken {
    CancellationToken::new()
}