bevy_iroh 0.5.0

Share Bevy entities between peers over iroh: replication, rooms, presence and typed messages, with optional voice and video
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

//! What replication puts on the wire.

use iroh::EndpointId;
use serde::{Deserialize, Serialize};

use super::{Authority, NetId};
use crate::net::{Kind, Payload};

/// One component as it travels: the codec's key and its encoded wire form.
pub type Component = (u64, Vec<u8>);

/// An entity, whole. Sent when it is first shared into a room and in snapshots.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Spawn {
    pub id: NetId,
    pub owner: EndpointId,
    pub authority: Authority,
    pub lamport: u64,
    pub components: Vec<Component>,
}
impl Payload for Spawn {
    const KIND: Kind = Kind::named("bevy_iroh/replicate/spawn/1");
}

/// Changed components, batched per room per frame.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Update {
    pub entities: Vec<EntityUpdate>,
}
impl Payload for Update {
    const KIND: Kind = Kind::named("bevy_iroh/replicate/update/1");
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct EntityUpdate {
    pub id: NetId,
    pub lamport: u64,
    pub components: Vec<Component>,
}

/// A component left an entity.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Remove {
    pub id: NetId,
    pub lamport: u64,
    pub key: u64,
}
impl Payload for Remove {
    const KIND: Kind = Kind::named("bevy_iroh/replicate/remove/1");
}

/// An entity is no longer shared, or no longer exists.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Despawn {
    pub id: NetId,
    pub lamport: u64,
}
impl Payload for Despawn {
    const KIND: Kind = Kind::named("bevy_iroh/replicate/despawn/1");
}

/// What the sender owns in this room, once a second. A receiver that lacks an id, or has an
/// older version, asks for it: the answer to gossip having dropped a message.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Manifest {
    pub entries: Vec<(NetId, u64)>,
}
impl Payload for Manifest {
    const KIND: Kind = Kind::named("bevy_iroh/replicate/manifest/1");
}

/// Direct, to the owner: send me these whole.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SnapshotRequest {
    pub ids: Vec<NetId>,
}
impl Payload for SnapshotRequest {
    const KIND: Kind = Kind::named("bevy_iroh/replicate/snapshot-request/1");
}

/// Direct, to a peer: everything I own here, or what they asked for.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Snapshot {
    pub spawns: Vec<Spawn>,
}
impl Payload for Snapshot {
    const KIND: Kind = Kind::named("bevy_iroh/replicate/snapshot/1");
}