Struct id_alloc::IdAlloc

pub struct IdAlloc { /* private fields */ }

An id allocator implemented by the bitmap. The true bit implies that the id is allocated, and vice versa.

Implementations

impl IdAlloc

pub fn with_capacity(capacity: usize) -> Self

Constructs a new id allocator with a maximum capacity.

pub fn from_bytes_with_capacity(slice: &[u8], capacity: usize) -> Self

Constructs a new id allocator from a slice of u8 bytes and a maximum capacity.

The slice of u8 bytes is the raw data of a bitmap.

pub fn alloc(&mut self) -> Option<usize>

Allocates and returns a new id.

If allocation is not possible, it returns None.

pub fn alloc_consecutive(&mut self, count: usize) -> Option<Range<usize>>

Allocates a consecutive range of new ids.

The count is the number of consecutive ids to allocate. If it is 0, return None.

If allocation is not possible, it returns None.

TODO: Choose a more efficient strategy.

pub fn free_consecutive(&mut self, range: Range<usize>)

Releases the consecutive range of allocated ids.

Panics

If the range is out of bounds, this method will panic.

pub fn free(&mut self, id: usize)

Releases the allocated id.

Panics

If the id is out of bounds, this method will panic.

pub fn alloc_specific(&mut self, id: usize) -> Option<usize>

Allocate a specific ID.

If the ID is already allocated, it returns None, otherwise it returns the allocated ID.

Panics

If the id is out of bounds, this method will panic.

pub fn is_allocated(&self, id: usize) -> bool

Returns true if the id is allocated.

Panics

If the id is out of bounds, this method will panic.

pub fn as_bytes(&self) -> &[u8]

Views the id allocator as a slice of u8 bytes.

Trait Implementations

impl Clone for IdAlloc

fn clone(&self) -> IdAlloc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IdAlloc

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

Formats the value using the given formatter.