downloader_mc 0.1.3

A library for downloading Minecraft assets and libraries.
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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

mod client_downloader;
mod downloader;
mod verify;

use std::{
    path::PathBuf,
    sync::{Arc, Mutex},
};

pub use client_downloader::*;
pub use downloader::*;
pub use verify::*;

use crate::{
    error::{ClientDownloaderError, DownloadError},
    manifest::Manifest,
};

pub type DownloadResult = Result<DownloadOutput, DownloadError>;

#[derive(Default, Clone)]
pub struct DownloadOutput {
    pub status: u16,
    pub file_name: String,
    pub file_path: PathBuf,
    pub verified: VerifyStatus,
}

/// A Progress reporter to use for the `Download`
pub type Progress = Arc<Mutex<dyn Reporter>>;

/// An interface for `ProgressReporter`s
pub trait Reporter: Send + Sync {
    fn setup(&mut self, _max_progress: u64) {}
    /// Report progress
    fn progress(&mut self, _current: u64) {}
    /// Finish up after progress reporting is done
    fn done(&mut self) {}
}

pub trait DownloadVersion {
    fn download_version(
        &self,
        _version_id: &str,
        _game_path: &PathBuf,
        _manifest_path: Option<&PathBuf>,
        _version_path: Option<&PathBuf>,
        _launcher: Option<Launcher>,
        _launcher_id: Option<&str>,
        _progress: Option<Progress>,
    ) -> Result<Vec<DownloadResult>, ClientDownloaderError>;

    fn setup_fabric(
        &self,
        _version_id: &str,
        _launcher_id: &str,
        _base_manifest: &mut Manifest,
    ) -> Result<Manifest, ClientDownloaderError>;

    fn create_profiles_json(&self, _game_path: &PathBuf) -> Result<(), ClientDownloaderError>;

    fn download_by_manifest(
        &self,
        _manifest: &Manifest,
        _game_path: &PathBuf,
        _version_path: Option<&PathBuf>,
        _progress: Option<Progress>,
    ) -> Result<Vec<DownloadResult>, ClientDownloaderError>;
}

pub trait DownloadJava {
    fn check_version(&self, _root_path: &str, _expected_version: &str) -> bool;
    fn download_java(&self, _root_path: &str, _version: &str, _progress: Option<Progress>);
}

fn download_result_to_fmt(
    f: &mut std::fmt::Formatter<'_>,
    summary: &DownloadOutput,
) -> std::fmt::Result {
    writeln!(
        f,
        "{}: (verification: {}) Status: {}",
        summary.file_name,
        match summary.verified {
            VerifyStatus::NotVerified => "unverified",
            VerifyStatus::Failed => "FAILED",
            VerifyStatus::Ok => "Ok",
        },
        summary.status,
    )?;
    Ok(())
}

impl std::fmt::Display for DownloadOutput {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        download_result_to_fmt(f, self)
    }
}

impl std::fmt::Debug for DownloadOutput {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        download_result_to_fmt(f, self)
    }
}