yule_log_macros 0.3.2

Derive macros for the yule_log ULOG parser crate.
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

# yule_log_macros

Derive macros for the [yule_log](https://crates.io/crates/yule_log) ULOG parser.

## Features

- **#[derive(ULogData)]:** Maps ULOG subscriptions directly into your structs.

- **#[derive(ULogMessages)]:** Aggregates your structs into a single streaming interface.

- **Forward unknown messages:** Capture raw ULOG messages via #[yule_log(forward_other)].

- **Memory Efficient:** Preserves the streaming nature of the yule_log parser.

## Quickstart

For more information, see: [yule_log](https://crates.io/crates/yule_log).

### Cargo.toml

```toml
yule_log = { version = "0.3", features = ["macros"] }
```

### Define mappings

```rust
#[derive(ULogData)]
pub struct VehicleLocalPosition {
pub timestamp: u64,
pub x: f32,
pub y: f32,
pub z: f32,
}
```

### Create an enum

```rust
#[derive(ULogMessages)]
pub enum LoggedMessages {
    VehicleLocalPosition(VehicleLocalPosition),
    #[yule_log(forward_other)]
    Other(yule_log::model::msg::UlogMessage),
}
```

### Iterate over data

```rust
let stream = LoggedMessages::stream(reader)?;
for msg_res in stream {
    let msg = msg_res?;
    match msg {
        LoggedMessages::VehicleLocalPosition(v) => println!("x={} y={} z={}", v.x, v.y, v.z),
        LoggedMessages::Other(msg) => println!("Other message: {:?}", msg),
    }
}
```

## License

This project is licensed under the [MIT Licence](LICENCE).