Skip to main content

Crate a2s_protocol

Crate a2s_protocol 

Source
Expand description

A parser and packet assembler for the Steam A2S server query protocol.

This crate builds A2S request packets, reassembles fragmented UDP responses, decompresses compressed responses, and parses the resulting payloads. It does not open sockets or send requests; networking stays with the calling application.

§Typical flow

Send a request with info_request, players_request, or rules_request. Pass each received datagram to PacketProcessor::process. When it returns a complete packet, parse it with parse_payload. If the response is a Response::Challenge, resend the matching request with the returned challenge.

use std::net::{SocketAddr, UdpSocket};
use a2s_protocol::{PacketProcessor, Response, info_request, parse_payload};

let socket = UdpSocket::bind("0.0.0.0:0")?;
socket.send_to(&info_request(None), server)?;
let mut processor = PacketProcessor::new();
let mut datagram = [0; a2s_protocol::MAX_PACKET_SIZE];

loop {
    let (len, source) = socket.recv_from(&mut datagram)?;
    let Some(packet) = processor.process(source, &datagram[..len])? else {
        continue;
    };
    match parse_payload(&packet)? {
        Response::Challenge(challenge) => {
            socket.send_to(&info_request(Some(challenge)), source)?;
        }
        response => {
            println!("{response:#?}");
            break;
        }
    }
}

Modules§

obsolete
Legacy GoldSrc response types and request builders.

Structs§

PacketProcessor
Reassembles fragmented server responses and decompresses compressed packets.
PlayersError
Error while parsing an A2S_PLAYER response. An A2S_PLAYER payload ended before all required fields were read or contained invalid UTF-8.
RulesError
Error while parsing an A2S_RULES response. An A2S_RULES payload ended before all fields were read or contained invalid UTF-8.

Enums§

InfoError
Error while parsing an A2S_INFO response. Errors found in an A2S_INFO response.
PayloadError
Errors that can occur while decoding a complete connectionless response.
Response
A decoded response returned by parse_payload.
TransportError
Errors produced while validating or reassembling server packets. Errors produced while validating, assembling, or decompressing packets.

Constants§

MAX_PACKET_SIZE
Recommended maximum size of one UDP datagram received from a server.

Functions§

info_request
Builds an A2S_INFO request packet.
parse_payload
Parses a complete connectionless response packet into its response type.
players_request
Builds an A2S_PLAYER request packet.
rules_request
Builds an A2S_RULES request packet.