Struct x11rb_protocol::id_allocator::IdAllocator

pub struct IdAllocator {
    next_id: u32,
    max_id: u32,
    increment: u32,
}

An allocator for X11 IDs.

This struct handles the client-side generation of X11 IDs. The ID allocation is based on a range of IDs that the server assigned us. This range is described by a base and a mask. From the X11 protocol reference manual:

The resource-id-mask contains a single contiguous set of bits (at least 18). The client allocates resource IDs [..] by choosing a value with only some subset of these bits set and ORing it with resource-id-base.

Fields

next_id: u32

max_id: u32

increment: u32

Implementations

impl IdAllocator

pub fn new(id_base: u32, id_mask: u32) -> Result<Self, ConnectError>

Create a new instance of an ID allocator.

The arguments should be the resource_id_base and resource_id_mask values that the X11 server sent in a Setup response.

pub fn update_xid_range( &mut self, xidrange: &GetXIDRangeReply, ) -> Result<(), IdsExhausted>

Update the available range of IDs based on a GetXIDRangeReply

pub fn generate_id(&mut self) -> Option<u32>

Generate the next ID.

Trait Implementations

impl Clone for IdAllocator

fn clone(&self) -> IdAllocator

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IdAllocator

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

Formats the value using the given formatter.

impl Copy for IdAllocator