lightyear 0.3.0

Server-client networking library for the Bevy game engine
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

use bitcode::encoding::Encoding;
use bitcode::Encode;
use serde::Serialize;

/// Buffer to facilitate writing bits
pub trait WriteBuffer: BitWrite {
    // type Writer: BitWrite;

    /// Serialize the given value into the buffer
    /// There is no padding when we serialize a value (i.e. it's possible to add a single bit
    /// to the buffer)

    fn serialize<T: Serialize + ?Sized>(&mut self, t: &T) -> anyhow::Result<()>;

    fn encode<T: Encode + ?Sized>(&mut self, t: &T, encoding: impl Encoding) -> anyhow::Result<()>;

    fn capacity(&self) -> usize;
    fn with_capacity(capacity: usize) -> Self;

    /// Clears the buffer.
    fn start_write(&mut self);

    /// Returns the finalized bytes (with padding to make a full byte)
    /// There is 0-7 bits of padding so that the serialized value is byte-aligned
    fn finish_write(&mut self) -> &[u8];

    fn num_bits_written(&self) -> usize;
    fn overflowed(&self) -> bool;

    /// Increase the maximum number of bits that can be written with this buffer
    /// (we are tracking them separately from the buffers capacity)
    fn reserve_bits(&mut self, num_bits: usize);

    /// Decrease the maximum number of bits that can be written with this buffer
    fn release_bits(&mut self, num_bits: usize);

    /// Set the number of bits that can be written to this buffer
    fn set_reserved_bits(&mut self, num_bits: usize);
}

pub trait BitWrite {
    fn write_bit(&mut self, bit: bool);
    fn write_bits(&mut self, bits: u32);
    fn write_bytes(&mut self, bytes: &[u8]);
}