windjammer-runtime 0.45.0

Runtime library for Windjammer standard library implementations
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

# Windjammer Runtime

**Runtime library backing Windjammer's standard library with production-grade Rust implementations.**

## What Is This?

`windjammer-runtime` is the bridge between Windjammer's clean, high-level standard library API and battle-tested Rust crates. When you write:

```windjammer
use std::http

fn main() {
    http.serve("0.0.0.0:3000", handler)
}
```

The Windjammer compiler generates Rust code that calls `windjammer_runtime::http`, which provides clean abstractions over `axum` and `reqwest`.

## Why Does This Exist?

**Proper Abstraction:** Windjammer controls the API contract, not external crates. If `axum` breaks compatibility in v0.8, we update `windjammer-runtime` internally—your Windjammer code keeps working.

**No Crate Leakage:** You write `std::http`, not `axum::`. You write `std::json`, not `serde_json::`. Clean, stable APIs.

**Future Flexibility:** We can swap implementations (e.g., `hyper` → `axum` → something better) without breaking user code.

## Modules

### Web Development
- **`http`** - HTTP client (reqwest) + server (axum)
- **`json`** - JSON serialization/deserialization (serde_json)

### File System & I/O
- **`fs`** - File operations (Rust stdlib)
- **`log`** - Production logging (env_logger)

### Data & Patterns
- **`regex_mod`** - Regular expressions (regex crate)
- **`db`** - Database access (sqlx)
- **`time`** - Time/date utilities (chrono)
- **`crypto`** - Cryptography (sha2, bcrypt, base64)
- **`random`** - Random generation (rand)

### System
- **`env`** - Environment variables
- **`process`** - Process execution
- **`collections`** - Data structures

### Developer Tools
- **`cli`** - CLI argument parsing (clap)
- **`testing`** - Test assertions
- **`csv_mod`** - CSV parsing (csv)
- **`strings`** - String utilities
- **`mime`** - MIME type handling (mime_guess)

## Usage

This crate is **not intended for direct use**. It's automatically included when the Windjammer compiler generates Rust code that uses stdlib modules.

### In Generated Code

```rust
// Generated by Windjammer compiler
use windjammer_runtime::http;
use windjammer_runtime::json;

#[tokio::main]
async fn main() {
    // Clean API, backed by reqwest/axum
    let client = http::Client::new();
    let response = client.get("https://api.example.com").await.unwrap();
    println!("{}", response.body);
}
```

## Architecture

```
Windjammer User Code (.wj)
    ↓
Windjammer Compiler
    ↓
Generated Rust Code (.rs)
    ↓
windjammer-runtime (this crate)
    ↓
Underlying Rust Crates (axum, reqwest, serde_json, etc.)
```

## Testing

```bash
# Run all tests
cargo test --all-features

# Run stdlib integration tests
cargo test --test integration_tests

# Run smoke tests
cargo test --test smoke_test
```

## Features

- **`db`** - Database support via sqlx (optional, off by default)

## Version Alignment

`windjammer-runtime` versions are **synchronized with Windjammer**:
- Windjammer v0.38.6 → windjammer-runtime v0.34.0
- Breaking changes increment major version for both

## Contributing

This crate is part of the Windjammer project. See the [main repository](https://github.com/jeffreyfriedman/windjammer) for contribution guidelines.

## License

Dual-licensed under MIT or Apache 2.0, same as Windjammer.