utls 0.5.4

A simple utilities library for stuff I actually use sometimes, with a large focus on convenience and lack of dependencies.
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

# Utils (utls)
A Rust utility library providing thread-safe progress bars and value watching functionality.

## Features
- **Progress Bars**: Highly customizable, thread-safe progress bars with:
  - Multiple built-in styles (Classic, Modern, Minimal, Fancy, ASCII, Dots, Arrows, Box)
  - Customizable appearance and behavior
  - Real-time statistics tracking
  - Spinner animations
  - Threading support
  - Formatted message templates

- **Value Watcher**: Thread-safe value monitoring system

## Usage Examples

### Progress Bar
```rust
use utls::prog::PB;
use std::thread;
use std::time::Duration;

fn main() {
    let pb = PB::modern(100);  // Create a modern style progress bar with 100 steps
    let (handle, pb_ref) = pb.threaded_start(); // Start the bar rendering in a new thread

    PB::inc_until_arc(pb_ref.clone(), || { // Run the Fn closure then increment until the bar finishes
        thread::sleep(Duration::from_millis(10)); // (or some work)
    });

    handle.join().unwrap();
    pb_ref.lock().unwrap().finish_with_message("Complete!");
}
```

### Value Watcher
```rust
use utls::watcher::Watcher;
use std::sync::{atomic::AtomicBool, Arc, Mutex};

fn main() {
    let shutdown = Arc::new(Mutex::new(AtomicBool::new(false)));
    let watcher = Watcher::new(0, 100, shutdown); // Initial value 0, poll every 100ms

    watcher.set_value(42);
    if watcher.has_changed() {
        println!("Value changed to: {}", watcher.get_value());
    }
}
```

## Progress Bar Styles
- `PB::classic()` - Traditional ASCII style
- `PB::modern()` - Unicode blocks style
- `PB::minimal()` - Minimalistic appearance
- `PB::fancy()` - Decorative Unicode style
- `PB::ascii()` - Pure ASCII characters
- `PB::dots()` - Braille pattern style
- `PB::arrows()` - Arrow-based style
- `PB::box_heavy()` - Heavy box drawing characters

## Message Formatting
Progress bars support the following template variables in messages if formatting is enabled:
- `{p}` - Progress percentage
- `{c}` - Current value
- `{m}` - Maximum value
- `{e}` - Elapsed time
- `{r}` - Estimated remaining time (highly inaccurate)

#### Note: enabling formatting can decrease performance

## Building
Requires Rust nightly due to `#![feature(unboxed_closures)]`.

## Examples
See the `/examples` directory for more usage examples:
- Progress bar demos: [PB](/examples/pb/)
- Watcher demos: [Watcher](/examples/watcher/)

## License
[License](LICENSE)