system-uptime 0.2.0

A cross-platform Rust library for retrieving operating system uptime.
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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

# system-uptime

<center><img src="https://raw.githubusercontent.com/greyshaman/system-uptime/refs/heads/main/images/photo_system-uptime.jpg" width="50%" alt="system-uptime"></center>

[![Crates.io](https://img.shields.io/crates/v/system-uptime.svg)](https://crates.io/crates/system-uptime)
[![Docs.rs](https://docs.rs/system-uptime/badge.svg)](https://docs.rs/system-uptime)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

A cross-platform Rust library for retrieving operating system uptime.

## Supported OS

- ✅ **Windows** (via `GetTickCount64`)
- ✅ **Linux** and **Android** (via `/proc/uptime`)
- ✅ **macOS**, **iOS**, **FreeBSD** (via `sysctl` with `KERN_BOOTTIME`)
- ✅ **Redox** (via `libredox::call::clock_gettime()`)

## Installation

Add to your `Cargo.toml`:

```toml
[dependencies]
system-uptime = "0.2.0"
```

or

```bash
$ cargo add system-uptime
```
## Usage

### Basic Example

```rust
use system_uptime::get_os_uptime;

fn main() {
    match get_os_uptime() {
        Ok(uptime_ms) => println!("System has been running for {} milliseconds", uptime_ms),
        Err(e) => eprintln!("Error: {}", e),
    }
}
```

### Getting Uptime as Duration

```rust
use system_uptime::get_os_uptime_duration;

fn main() {
    match get_os_uptime_duration() {
        Ok(duration) => {
            println!("Total uptime: {:?}", duration);
            println!("Seconds: {}", duration.as_secs());
            println!("Milliseconds: {}", duration.as_millis());
        }
        Err(e) => eprintln!("Error: {}", e),
    }
}
```

### Formatting Uptime

```rust
use system_uptime::get_os_uptime_duration;
use std::time::Duration;

fn format_uptime(duration: Duration) -> String {
    let total_seconds = duration.as_secs();
    let days = total_seconds / 86400;
    let hours = (total_seconds % 86400) / 3600;
    let minutes = (total_seconds % 3600) / 60;
    let seconds = total_seconds % 60;

    if days > 0 {
        format!("{}d {}h {}m {}s", days, hours, minutes, seconds)
    } else if hours > 0 {
        format!("{}h {}m {}s", hours, minutes, seconds)
    } else if minutes > 0 {
        format!("{}m {}s", minutes, seconds)
    } else {
        format!("{}s", seconds)
    }
}

fn main() {
    if let Ok(duration) = get_os_uptime_duration() {
        println!("Uptime: {}", format_uptime(duration));
    }
}
```

## API

### `get_os_uptime() -> Result<u64, Box<dyn Error>>`

Returns system uptime in milliseconds.

Returns:

- `Ok(u64)` - number of milliseconds since system boot

- `Err(Box<dyn Error>)` - error retrieving uptime

### `get_os_uptime_duration() -> Result<Duration, Box<dyn Error>>`

Returns system uptime as `std::time::Duration`.

## Precision

- __Windows:__ precision ~10-16 milliseconds

- __Linux/Android:__ precision ~10 milliseconds (from /proc/uptime)

- __macOS/BSD:__ precision ~1 second (via sysctl)

- __Redox-OS__ precision ~10 milliseconds

## Example Output

```text
// On a system running for 2.5 hours:
System has been running for 9000000 milliseconds
Total uptime: 2.5h
Formatted: 2h 30m 0s
```

## Dependencies

- `libc` - for Unix-like systems

- `winapi` - for Windows (automatically included only on Windows)

- `libredox` - for Redox-OS

## License

MIT License - see LICENSE file.

## Contributing

Issues and Pull Requests are welcome!