haki-dl 0.3.0

A Rust downloader library and CLI foundation.
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

//! Async-ready component traits.

use std::future::Future;
use std::path::Path;

use crate::config::DownloadOptions;
use crate::error::Result;
use crate::event::ProgressEvent;
use crate::http::{HttpRequest, HttpResponse};
use crate::manifest::{Manifest, Stream};
use crate::mux::OutputArtifact;

/// HTTP transport abstraction.
pub trait HttpClient {
    /// Sends one HTTP request.
    fn send(&self, request: HttpRequest) -> impl Future<Output = Result<HttpResponse>> + Send + '_;
}

/// Storage abstraction.
pub trait Storage {
    /// Writes bytes to a path.
    fn write_all<'a>(
        &'a self,
        path: &'a Path,
        bytes: &'a [u8],
    ) -> impl Future<Output = Result<()>> + Send + 'a;
}

/// Manifest loading abstraction.
pub trait ManifestLoader {
    /// Loads and parses a manifest.
    fn load(&self, input: &str) -> impl Future<Output = Result<Manifest>> + Send + '_;
}

/// Key provider abstraction.
pub trait KeyProvider {
    /// Resolves key material by identifier.
    fn key_for(&self, key_id: &str) -> impl Future<Output = Result<Option<Vec<u8>>>> + Send + '_;
}

/// Decryptor abstraction.
pub trait Decryptor {
    /// Decrypts one input into one output path.
    fn decrypt<'a>(
        &'a self,
        input: &'a Path,
        output: &'a Path,
    ) -> impl Future<Output = Result<()>> + Send + 'a;
}

/// Muxer abstraction.
pub trait Muxer {
    /// Muxes selected stream artifacts into final artifacts.
    fn mux<'a>(
        &'a self,
        streams: &'a [Stream],
        options: &'a DownloadOptions,
    ) -> impl Future<Output = Result<Vec<OutputArtifact>>> + Send + 'a;
}

/// Progress sink abstraction.
pub trait ProgressSink {
    /// Emits one event.
    fn emit(&self, event: ProgressEvent) -> Result<()>;
}

/// Cancellation abstraction.
pub trait Cancellation {
    /// Returns whether cancellation has been requested.
    fn is_cancelled(&self) -> bool;
}