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

use std::num::NonZeroUsize;

use anyhow::Result;
use bitcode::encoding::Encoding;
use bitcode::word::Word;
use bitcode::Decode;
use serde::de::DeserializeOwned;

pub trait ReadBuffer: BitRead {
    fn capacity(&self) -> usize;

    /// Deserialize from the buffer using serde
    fn deserialize<T: DeserializeOwned>(&mut self) -> Result<T>;

    /// Deserialize from the buffer using bitcode
    fn decode<T: Decode>(&mut self, encoding: impl Encoding) -> Result<T>;

    /// Copy the bytes into the buffer, so that we can deserialize them
    fn start_read(bytes: &[u8]) -> Self;

    /// Check for errors such as Eof and ExpectedEof
    fn finish_read(&mut self) -> Result<()>;
}

/// Abstracts over reading bits from a buffer.
pub trait BitRead {
    /// Advances any amount of bits. Must never fail.
    fn advance(&mut self, bits: usize);
    /// Peeks 64 bits without reading them. Bits after EOF are zeroed.
    fn peek_bits(&mut self) -> Result<Word>;

    // Reads 1 bit.
    fn read_bit(&mut self) -> Result<bool>;
    /// Reads up to 64 bits. `bits` must be in range `1..=64`.
    fn read_bits(&mut self, bits: usize) -> Result<Word>;
    /// Reads `len` bytes.
    fn read_bytes(&mut self, len: NonZeroUsize) -> Result<&[u8]>;
    /// Ensures that at least `bits` remain. Never underreports remaining bits.
    fn reserve_bits(&self, bits: usize) -> Result<()>;
}