Struct MsgBase 

pub struct MsgBase {
    pub payload: Vec<u8>,
    pub position: u64,
}

The payload of a client message: a byte buffer with a cursor.

Fields

payload: Vec<u8>

The raw bytes of the message payload.

position: u64

The read/write cursor into MsgBase::payload.

Implementations

impl MsgBase

pub fn new(payload_reserve: usize) -> Self

Creates an empty payload with the given initial capacity.

pub fn from_bytes(data: &[u8]) -> Self

Creates a payload pre-filled with data, positioned at the start.

pub fn seek(&mut self, offset: u64) -> u64

Seeks to offset from the beginning of the payload.

Returns the new position.

pub fn seek_from(&mut self, offset: u64, origin: SeekOrigin) -> u64

Seeks to offset relative to origin and returns the new position.

pub fn len(&self) -> usize

The number of bytes held in the payload.

pub fn is_empty(&self) -> bool

Whether the payload holds no bytes.

pub fn to_bytes(&self) -> Vec<u8>

A copy of the whole payload, not just the part after the cursor.

pub fn reader(&self) -> Reader<'_>

A borrowing reader over the part of the payload after the cursor.

pub fn write_u8(&mut self, v: u8)

Writes a single unsigned byte.

pub fn write_i8(&mut self, v: i8)

Writes a single signed byte.

pub fn write_u16(&mut self, v: u16)

Writes a single unsigned 16 bit short.

pub fn write_i16(&mut self, v: i16)

Writes a single signed 16 bit short.

pub fn write_u32(&mut self, v: u32)

Writes a single unsigned 32 bit integer.

pub fn write_i32(&mut self, v: i32)

Writes a single signed 32 bit integer.

pub fn write_u64(&mut self, v: u64)

Writes a single unsigned 64 bit integer.

pub fn write_i64(&mut self, v: i64)

Writes a single signed 64 bit integer.

pub fn write_f32(&mut self, v: f32)

Writes a single 32 bit float.

pub fn write_f64(&mut self, v: f64)

Writes a single 64 bit double.

pub fn write_bytes(&mut self, v: &[u8])

Writes v at the cursor and advances it. Writing past the end zero-fills the gap.

pub fn write_string(&mut self, v: &str)

Writes the UTF-8 bytes of v, without a terminator.

pub fn write_null_term_string(&mut self, v: &str)

Writes the UTF-8 bytes of v followed by a null terminator.

pub fn read_exact(&mut self, count: usize) -> Result<Vec<u8>, SteamError>

Reads exactly count bytes and advances the cursor.

pub fn read_bytes(&mut self, count: usize) -> Vec<u8>

Reads up to count bytes and advances the cursor. Returns fewer bytes if the payload runs out instead of failing.

pub fn read_u8(&mut self) -> Result<u8, SteamError>

Reads a single unsigned byte.

pub fn read_i8(&mut self) -> Result<i8, SteamError>

Reads a single signed byte.

pub fn read_u16(&mut self) -> Result<u16, SteamError>

Reads a single unsigned 16 bit short.

pub fn read_i16(&mut self) -> Result<i16, SteamError>

Reads a single signed 16 bit short.

pub fn read_u32(&mut self) -> Result<u32, SteamError>

Reads a single unsigned 32 bit integer.

pub fn read_i32(&mut self) -> Result<i32, SteamError>

Reads a single signed 32 bit integer.

pub fn read_u64(&mut self) -> Result<u64, SteamError>

Reads a single unsigned 64 bit integer.

pub fn read_i64(&mut self) -> Result<i64, SteamError>

Reads a single signed 64 bit integer.

pub fn read_f32(&mut self) -> Result<f32, SteamError>

Reads a single 32 bit float.

pub fn read_f64(&mut self) -> Result<f64, SteamError>

Reads a single 64 bit double.

pub fn read_null_term_string(&mut self) -> Result<String, SteamError>

Reads a null terminated UTF-8 string, consuming the terminator.

pub fn read_int8(&mut self) -> Result<i8, SteamError>

Same as read_i8.

pub fn read_sbyte(&mut self) -> Result<i8, SteamError>

Same as read_i8.

pub fn read_uint8(&mut self) -> Result<u8, SteamError>

Same as read_u8.

pub fn read_byte(&mut self) -> Result<u8, SteamError>

Same as read_u8.

pub fn read_int16(&mut self) -> Result<i16, SteamError>

Same as read_i16.

pub fn read_short(&mut self) -> Result<i16, SteamError>

Same as read_i16.

pub fn read_uint16(&mut self) -> Result<u16, SteamError>

Same as read_u16.

pub fn read_ushort(&mut self) -> Result<u16, SteamError>

Same as read_u16.

pub fn read_int32(&mut self) -> Result<i32, SteamError>

Same as read_i32.

pub fn read_int(&mut self) -> Result<i32, SteamError>

Same as read_i32.

pub fn read_uint32(&mut self) -> Result<u32, SteamError>

Same as read_u32.

pub fn read_uint(&mut self) -> Result<u32, SteamError>

Same as read_u32.

pub fn read_int64(&mut self) -> Result<i64, SteamError>

Same as read_i64.

pub fn read_long(&mut self) -> Result<i64, SteamError>

Same as read_i64.

pub fn read_uint64(&mut self) -> Result<u64, SteamError>

Same as read_u64.

pub fn read_ulong(&mut self) -> Result<u64, SteamError>

Same as read_u64.

pub fn read_single(&mut self) -> Result<f32, SteamError>

Same as read_f32.

pub fn read_float(&mut self) -> Result<f32, SteamError>

Same as read_f32.

pub fn read_double(&mut self) -> Result<f64, SteamError>

Same as read_f64.

Trait Implementations

impl Clone for MsgBase

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MsgBase

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for MsgBase

fn default() -> Self

Returns the “default value” for a type.