js-protocol 0.1.0

Generated Rust types for js_protocol.json
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

# js-protocol


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

A high-performance, fully type-safe Rust representation of the **Chrome DevTools JavaScript Protocol (js_protocol)**, automatically generated from the official protocol definitions.

## 🚀 Key Features


- **Automated Type Generation**: Derived from official V8/Chrome protocol definitions.
- **Intelligent Integer Mapping**:
  - `i32`: Used for coordinates, offsets, and line/column numbers.
  - `u64`: Used for identifiers, counts, sizes, and ordinals.
  - `i64`: Default for general integer values.
- **Recursive Type Safety**: Handles recursive structures via `Box<T>` indirection.
- **Optimized Serialization**: 
  - Uses `serde` with `camelCase` renaming to match the protocol exactly.
  - Optional fields are omitted from JSON if `None` to reduce network overhead.
- **Full Documentation**: Protocol descriptions included as Rustdoc comments.

## 📦 Installation


Add this to your `Cargo.toml`:

```toml
[dependencies]
js-protocol = "0.1.0"
serde = { version = "1.0", features = ["derive"] }
serde_json = "1.0"
```

## 🛠 Usage Example


```rust
use js_protocol::runtime::{EvaluateParams, RemoteObject};

fn main() {
    // Example: Constructing a 'Runtime.evaluate' request
    let params = EvaluateParams {
        expression: "console.log('Hello from Rust!')".to_string(),
        ..Default::default()
    };

    println!("Serialized request: {:?}", serde_json::to_string(&params));
}
```