lighty-java 26.5.7

Java runtime management for Lighty Launcher
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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

# Exports

Public surface of `lighty-java`.

## Root re-exports

```rust,ignore
pub use lighty_java::{
    JavaDistribution, DistributionSelection,
    JreError,             JreResult,
    JavaRuntimeError,     JavaRuntimeResult,
    DistributionError,    DistributionResult,
};
```

## Module-by-module

### `jre_downloader`

```rust,ignore
pub async fn find_java_binary(
    runtimes_folder: &Path,
    distribution: &JavaDistribution,
    version: &u8,
) -> JreResult<PathBuf>;

#[cfg(feature = "events")]
pub async fn jre_download<F: Fn(u64, u64)>(
    runtimes_folder: &Path,
    distribution: &JavaDistribution,
    version: &u8,
    on_progress: F,
    event_bus: Option<&EventBus>,
) -> JreResult<PathBuf>;

#[cfg(not(feature = "events"))]
pub async fn jre_download<F: Fn(u64, u64)>(
    runtimes_folder: &Path,
    distribution: &JavaDistribution,
    version: &u8,
    on_progress: F,
) -> JreResult<PathBuf>;
```

### `runtime`

```rust,ignore
pub struct JavaRuntime(pub PathBuf);

impl JavaRuntime {
    pub fn new(path: PathBuf) -> Self;
    pub async fn execute(&self, arguments: Vec<String>, game_dir: &Path)
        -> JavaRuntimeResult<tokio::process::Child>;
    pub async fn handle_io<D: Send + Sync>(
        &self,
        process: &mut tokio::process::Child,
        on_stdout: fn(&D, &[u8]) -> JavaRuntimeResult<()>,
        on_stderr: fn(&D, &[u8]) -> JavaRuntimeResult<()>,
        terminator: tokio::sync::oneshot::Receiver<()>,
        data: &D,
    ) -> JavaRuntimeResult<()>;
}
```

### Top-level types

```rust,ignore
pub enum JavaDistribution { Temurin, GraalVM, Zulu, Liberica }

impl JavaDistribution {
    pub fn get_name(&self) -> &str;                              // "temurin" | "graalvm" | "zulu" | "liberica"
    pub fn supports_version(&self, version: u8) -> bool;
    pub fn get_fallback(&self, version: u8) -> Option<JavaDistribution>;
    pub async fn get_download_url(&self, jre_version: &u8) -> DistributionResult<String>;
}

pub enum DistributionSelection {
    Automatic(String),                  // serde tag = "automatic"
    Custom(String),                     // serde tag = "custom"
    Manual(JavaDistribution),           // serde tag = "manual"
}
```

`Default for JavaDistribution` returns `Temurin`. `Default for
DistributionSelection` returns `Automatic(String::new())`.

### Errors

```rust,ignore
pub enum JreError {
    NotFound { path: PathBuf }, InvalidStructure, Download(String),
    UnsupportedOS, Io(std::io::Error), Extraction(String),
}

pub enum JavaRuntimeError {
    NotFound { path: PathBuf }, NonZeroExit { code: i32 },
    IoCaptureFailure, Spawn(std::io::Error), SignalTerminated,
}

pub enum DistributionError {
    UnsupportedVersion { version: u8, distribution: &'static str },
    ApiError    { distribution: &'static str, error: String },
    JsonParseError { distribution: &'static str, error: String },
    NoPackagesFound { distribution: &'static str },
    System(lighty_core::SystemError),
}
```

## Cargo features

| Feature | Effect |
|---|---|
| `events` | `jre_download` gains the `Option<&EventBus>` arg and emits `JavaEvent`. |

## See also

- [`how-to-use.md`](./how-to-use.md) — install + run a JRE
- [`distributions.md`](./distributions.md) — provider matrix
- [`installation.md`](./installation.md) — `jre_download` pipeline
- [`runtime.md`](./runtime.md) — `JavaRuntime` API
- [`events.md`](./events.md) — `JavaEvent` variants