Struct ByteReader

pub struct ByteReader<'a> { /* private fields */ }

Implementations

impl<'a> ByteReader<'a>

pub fn new(data: &'a [u8], endian: Endian) -> Self

Examples found in repository

examples/transcode.rs (line 43)

fn main() -> ByteReaderResult<()> {
    #[rustfmt::skip]
    let bytes: Vec<u8> = vec![
        // Game ID (UUIDv4)
        26, 159, 68, 107, 159, 116, 65, 60, 136, 44, 246, 216, 52, 76, 64, 30,

        // Join Code (String)
        4, 84, 111, 100, 100,

        // Lobby size (u8)
        2,

        // Account 1
        // (UUIDv4)
        26, 159, 68, 107, 159, 116, 65, 60, 136, 44, 246, 216, 52, 76, 64, 30,
        // (String)
        4, 84, 111, 100, 100,

        // Account 2
        // (UUIDv4)
        26, 159, 68, 107, 159, 116, 65, 60, 136, 44, 246, 216, 52, 76, 64, 30,
        // (String)
        4, 84, 111, 100, 100,
    ];

    let mut byte_reader: ByteReader = ByteReader::new(&bytes, Endian::Little);

    let game_id: Uuid = byte_reader.read_uuid()?;
    let join_code: String = byte_reader.read_string()?;

    let mut lobby: Vec<Account> = Vec::new();
    let lobby_len: u8 = byte_reader.read_u8()?;
    for _ in 0..lobby_len {
        lobby.push(Account {
            account_id: byte_reader.read_uuid()?,
            username: byte_reader.read_string()?,
        });
    }

    println!(
        "{:?}",
        Payload {
            game_id,
            join_code,
            lobby,
        }
    );
    Ok(())
}

pub fn read_u8(&mut self) -> ByteReaderResult<u8>

Errors

Will return an error if there are not enough bytes to read.

Examples found in repository

examples/transcode.rs (line 49)

fn main() -> ByteReaderResult<()> {
    #[rustfmt::skip]
    let bytes: Vec<u8> = vec![
        // Game ID (UUIDv4)
        26, 159, 68, 107, 159, 116, 65, 60, 136, 44, 246, 216, 52, 76, 64, 30,

        // Join Code (String)
        4, 84, 111, 100, 100,

        // Lobby size (u8)
        2,

        // Account 1
        // (UUIDv4)
        26, 159, 68, 107, 159, 116, 65, 60, 136, 44, 246, 216, 52, 76, 64, 30,
        // (String)
        4, 84, 111, 100, 100,

        // Account 2
        // (UUIDv4)
        26, 159, 68, 107, 159, 116, 65, 60, 136, 44, 246, 216, 52, 76, 64, 30,
        // (String)
        4, 84, 111, 100, 100,
    ];

    let mut byte_reader: ByteReader = ByteReader::new(&bytes, Endian::Little);

    let game_id: Uuid = byte_reader.read_uuid()?;
    let join_code: String = byte_reader.read_string()?;

    let mut lobby: Vec<Account> = Vec::new();
    let lobby_len: u8 = byte_reader.read_u8()?;
    for _ in 0..lobby_len {
        lobby.push(Account {
            account_id: byte_reader.read_uuid()?,
            username: byte_reader.read_string()?,
        });
    }

    println!(
        "{:?}",
        Payload {
            game_id,
            join_code,
            lobby,
        }
    );
    Ok(())
}

pub fn read_i8(&mut self) -> ByteReaderResult<i8>

Errors

Will return an error if there are not enough bytes to read.

pub fn read_u16(&mut self) -> ByteReaderResult<u16>

Errors

Will return an error if there are not enough bytes to read.

pub fn read_i16(&mut self) -> ByteReaderResult<i16>

Errors

Will return an error if there are not enough bytes to read.

pub fn read_u32(&mut self) -> ByteReaderResult<u32>

Errors

Will return an error if there are not enough bytes to read.

pub fn read_i32(&mut self) -> ByteReaderResult<i32>

Errors

Will return an error if there are not enough bytes to read.

pub fn read_u64(&mut self) -> ByteReaderResult<u64>

Errors

Will return an error if there are not enough bytes to read.

pub fn read_i64(&mut self) -> ByteReaderResult<i64>

Errors

Will return an error if there are not enough bytes to read.

pub fn read_string(&mut self) -> ByteReaderResult<String>

Errors

Will return an error if there are not enough bytes to read or if the UTF-8 bytes are invalid.

Examples found in repository

examples/transcode.rs (line 46)

fn main() -> ByteReaderResult<()> {
    #[rustfmt::skip]
    let bytes: Vec<u8> = vec![
        // Game ID (UUIDv4)
        26, 159, 68, 107, 159, 116, 65, 60, 136, 44, 246, 216, 52, 76, 64, 30,

        // Join Code (String)
        4, 84, 111, 100, 100,

        // Lobby size (u8)
        2,

        // Account 1
        // (UUIDv4)
        26, 159, 68, 107, 159, 116, 65, 60, 136, 44, 246, 216, 52, 76, 64, 30,
        // (String)
        4, 84, 111, 100, 100,

        // Account 2
        // (UUIDv4)
        26, 159, 68, 107, 159, 116, 65, 60, 136, 44, 246, 216, 52, 76, 64, 30,
        // (String)
        4, 84, 111, 100, 100,
    ];

    let mut byte_reader: ByteReader = ByteReader::new(&bytes, Endian::Little);

    let game_id: Uuid = byte_reader.read_uuid()?;
    let join_code: String = byte_reader.read_string()?;

    let mut lobby: Vec<Account> = Vec::new();
    let lobby_len: u8 = byte_reader.read_u8()?;
    for _ in 0..lobby_len {
        lobby.push(Account {
            account_id: byte_reader.read_uuid()?,
            username: byte_reader.read_string()?,
        });
    }

    println!(
        "{:?}",
        Payload {
            game_id,
            join_code,
            lobby,
        }
    );
    Ok(())
}

pub fn read_uuid(&mut self) -> ByteReaderResult<Uuid>

Errors

Will return an error if there are not enough bytes to read or if the UUID bytes are invalid.

Examples found in repository

examples/transcode.rs (line 45)

fn main() -> ByteReaderResult<()> {
    #[rustfmt::skip]
    let bytes: Vec<u8> = vec![
        // Game ID (UUIDv4)
        26, 159, 68, 107, 159, 116, 65, 60, 136, 44, 246, 216, 52, 76, 64, 30,

        // Join Code (String)
        4, 84, 111, 100, 100,

        // Lobby size (u8)
        2,

        // Account 1
        // (UUIDv4)
        26, 159, 68, 107, 159, 116, 65, 60, 136, 44, 246, 216, 52, 76, 64, 30,
        // (String)
        4, 84, 111, 100, 100,

        // Account 2
        // (UUIDv4)
        26, 159, 68, 107, 159, 116, 65, 60, 136, 44, 246, 216, 52, 76, 64, 30,
        // (String)
        4, 84, 111, 100, 100,
    ];

    let mut byte_reader: ByteReader = ByteReader::new(&bytes, Endian::Little);

    let game_id: Uuid = byte_reader.read_uuid()?;
    let join_code: String = byte_reader.read_string()?;

    let mut lobby: Vec<Account> = Vec::new();
    let lobby_len: u8 = byte_reader.read_u8()?;
    for _ in 0..lobby_len {
        lobby.push(Account {
            account_id: byte_reader.read_uuid()?,
            username: byte_reader.read_string()?,
        });
    }

    println!(
        "{:?}",
        Payload {
            game_id,
            join_code,
            lobby,
        }
    );
    Ok(())
}

pub fn read_remaining_bytes(&mut self) -> Vec<u8>

pub fn is_empty(&self) -> bool

pub fn remaining(&self) -> usize