metaverse_messages 0.3.0

packet definitions for the open metaverse
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

use byteorder::{LittleEndian, ReadBytesExt};

use crate::errors::ParseError;
use crate::packet::{
    header::{Header, PacketFrequency},
    packet::{Packet, PacketData},
    packet_types::PacketType,
};
use crate::udp::object::util::ObjectFlag;
use std::io::Cursor;

impl Packet {
    /// create a new object update cached packet
    pub fn new_object_update_cached(object_update_cached: ObjectUpdateCached) -> Self {
        Packet {
            header: Header {
                id: 14,
                reliable: true,
                zerocoded: false,
                frequency: PacketFrequency::High,
                ..Default::default()
            },
            body: PacketType::ObjectUpdateCached(Box::new(object_update_cached)),
        }
    }
}

/// ObjectUpdateCached packets are sent from the server when it expects the client to already have
/// the objects in the cache. This contains a very limited subset of data, to minimize bandwidth
/// usage.
#[derive(Debug, Clone)]
pub struct ObjectUpdateCached {
    /// region ID of the object
    pub region_handle: u64,
    /// time dilation of the region
    pub time_dilation: u16,
    /// objects to check for in cache
    pub objects: Vec<CachedObjectData>,
}

/// the object data to check the cache for
#[derive(Debug, Clone)]
pub struct CachedObjectData {
    /// scene-local ID of the object
    pub id: u32,
    /// crc to check if there has been an update to the object
    pub crc: u32,
    /// object flags
    pub flags: Vec<ObjectFlag>,
}

impl PacketData for ObjectUpdateCached {
    fn from_bytes(bytes: &[u8]) -> Result<Self, ParseError> {
        let mut cursor = Cursor::new(bytes);
        let region_handle = cursor.read_u64::<LittleEndian>()?;
        let time_dilation = cursor.read_u16::<LittleEndian>()?;
        let data_len = cursor.read_u8()?;

        let mut objects = Vec::new();
        for _ in 0..data_len {
            let id = cursor.read_u32::<LittleEndian>()?;
            let crc = cursor.read_u32::<LittleEndian>()?;
            let flags = ObjectFlag::from_bytes(cursor.read_u32::<LittleEndian>()?);
            objects.push(CachedObjectData { id, crc, flags });
        }
        Ok(ObjectUpdateCached {
            region_handle,
            time_dilation,
            objects,
        })
    }
    fn to_bytes(&self) -> Vec<u8> {
        Vec::new()
    }
}