Struct x11rb_protocol::packet_reader::PacketReader

pub struct PacketReader {
    pending_packet: Vec<u8>,
    already_read: usize,
}

A wrapper around a buffer used to read X11 packets.

Fields

pending_packet: Vec<u8>

A partially-read packet.

already_read: usize

The point at which the packet is already read.

Implementations

impl PacketReader

pub fn new() -> Self

Create a new, empty PacketReader.

Example

let reader = PacketReader::new();

pub fn buffer(&mut self) -> &mut [u8]

Get the buffer that the reader should fill with data.

Example

let mut reader = PacketReader::new();
let buffer: [u8; 32] = read_in_buffer();

reader.buffer().copy_from_slice(&buffer);

pub fn remaining_capacity(&self) -> usize

The remaining capacity that needs to be filled.

pub fn advance(&mut self, amount: usize) -> Option<Vec<u8>>

Advance this buffer by the given amount.

This will return the packet that was read, if enough bytes were read in order to form a complete packet.

Trait Implementations

impl Debug for PacketReader

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

Formats the value using the given formatter.

impl Default for PacketReader

fn default() -> Self

Returns the “default value” for a type.