use-event-envelope 0.1.0

Generic event envelope composed from RustUse event primitives.
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

# use-event-envelope

Generic event envelope composed from `RustUse` event primitives.

## Install

```toml
[dependencies]
use-event-envelope = "0.1.0"
```

## Example

```rust
use use_event_envelope::EventEnvelope;
use use_event_kind::EventKind;
use use_event_name::EventName;
use use_event_source::EventSource;

let event = EventEnvelope::new(
    EventName::new("command.started"),
    EventKind::Started,
    EventSource::new("cli"),
    "rustuse build",
);

assert_eq!(event.name.as_str(), "command.started");
assert_eq!(event.payload, "rustuse build");
```

## Scope

- Compose event id, name, kind, source, target, timestamp, metadata, and caller-owned payload values.
- Provide builder-style helpers for caller-supplied ids, targets, metadata, and timestamps.
- Use `EventId::default()` in `new` because v0.1.0 intentionally does not generate identifiers.

## Non-Goals

- No UUID generation.
- No serialization or persistence.
- No dispatch, queue, broker, scheduler, or runtime behavior.

## Status

Experimental v0.1.0 primitive.

## License

Licensed under either of the following, at your option:

- Apache License, Version 2.0
- MIT license