active-uuid-registry

A functional interface for managing sets of UUIDs organized by named contexts in a global registry. Useful for tracking running components in dynamic and complex systems.

Installation

Add to your Cargo.toml:

[dependencies]
active-uuid-registry = "0.4.1"

By default, the registry uses a mutex-protected hashmap of arc and hashsets. For concurrent access with DashMap/DashSet, enable the concurrent-map feature:

[dependencies]
active-uuid-registry = { version = "0.4.1", features = ["concurrent-map"] }

Usage

use active_uuid_registry::interface::{reserve, add, remove, try_remove, replace, get, get_all, clear_context, clear_all};
use active_uuid_registry::UuidPoolError;
use uuid::Uuid;

// Reserve a new UUID in a named context
let reserve_res: Result<Uuid, UuidPoolError> = reserve("server");

// Add an existing UUID to a context
let custom_uuid = Uuid::...; // create your UUID here
let add_res: Result<(), UuidPoolError> = add("client", custom_uuid);
let add_res: Result<(), UuidPoolError> = add("player_entity", custom_uuid);

// Remove a UUID from a context
let remove_res: Result<(), UuidPoolError> = remove("client", uuid);

// Try to remove the UUID from the `client` context
let removed: bool = try_remove("client", custom_uuid);

// Replace one UUID with another within the same context
let old = reserve("server").unwrap();
let new = Uuid::...; // create your UUID here
let replace_res: Result<(), UuidPoolError> = replace("server", old, new);

// Get all UUIDs for any given context
let ids: Result<Vec<(String, Uuid)>, UuidPoolError> = get("server");

// Get all UUIDs currently stored
let all_ids: Result<Vec<(String, Uuid)>, UuidPoolError> = get_all();

// Clear all UUIDs from a certain context
let clear_res: Result<(), UuidPoolError> = clear_context("server");

// Clear all UUIDs from all contexts
let clear_res: Result<(), UuidPoolError> = clear_all_contexts();

// Clears and returns all UUIDs from a certain context
let drain_res: Result<Vec<(String, Uuid)>, UuidPoolError> = drain_context("player_entity");

// Clears and returns all UUIDs from all contexts
let drain_res: Result<Vec<(String, Uuid)>, UuidPoolError> = drain_all_contexts();

API

License

MIT