a2s-protocol 0.1.1

A protocol core for building A2S server query clients
Documentation
use crate::cursor;

mod packet;
pub (crate) mod compression;
mod packet_assembler;
pub mod packet_processor;

// Steam uses a packet size of up to 1400 bytes + IP/UDP headers
pub const MAX_PACKET_SIZE: usize = 1400;
pub const CONNECTIONLESS_HEADER: i32 = -1;

#[derive(thiserror::Error, Debug)]
/// Errors produced while validating, assembling, or decompressing packets.
pub enum Error {
    /// A packet ended before a required header field was available.
    #[error("failed to read packet")]
    Read(#[from] cursor::Error),
    /// The packet does not begin with a recognized connectionless header.
    #[error("invalid packet header: {0}")]
    InvalidPacketHeader(i32),
    /// More fragments arrived than the sequence header declared.
    #[error("packet contains {num} fragments, expected {expected}")]
    ManyPackets{ num: u8, expected: u8},
    /// Fragment numbers were duplicated or were not in a valid sequence.
    #[error("packet fragments are in an invalid order")]
    InvalidOrder,
    /// A compressed payload could not be decoded or failed its integrity checks.
    #[error(transparent)]
    Compression(#[from] compression::Error),
}