Struct ObjectHandle 

pub struct ObjectHandle { /* private fields */ }

A handle to an object managed by the object registry

Handles are lightweight, copyable references that include:

• object_type: The type of object being referenced
• id: Unique identifier for this object
• generation: Counter incremented each time an ID is reused

The generation counter prevents the ABA problem where an object is deleted and a new object reuses the same ID.

Examples

use scarab_plugin_api::object_model::{ObjectHandle, ObjectType};

let handle = ObjectHandle::new(ObjectType::Window, 42, 1);
assert_eq!(handle.id(), 42);
assert_eq!(handle.object_type(), ObjectType::Window);
assert_eq!(handle.generation(), 1);

Implementations

impl ObjectHandle

pub const fn new(object_type: ObjectType, id: u64, generation: u32) -> Self

Create a new object handle

Arguments

• object_type - The type of object this handle references
• id - Unique identifier for this object
• generation - Generation counter for detecting stale handles

pub const fn object_type(&self) -> ObjectType

Get the object type

pub const fn id(&self) -> u64

Get the object ID

pub const fn generation(&self) -> u32

Get the generation counter

pub const fn is_valid(&self, current_generation: u32) -> bool

Check if this handle is valid for the given generation

Returns true if the handle’s generation matches the provided generation, indicating the handle is still valid and hasn’t been invalidated by object deletion/recreation.

Examples

use scarab_plugin_api::object_model::{ObjectHandle, ObjectType};

let handle = ObjectHandle::new(ObjectType::Window, 1, 5);
assert!(handle.is_valid(5));
assert!(!handle.is_valid(6));

pub const fn next_generation(&self) -> Self

Create a new handle with an incremented generation

This is useful when an object is deleted and its ID is reused for a new object.

Trait Implementations

impl Clone for ObjectHandle

fn clone(&self) -> ObjectHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ObjectHandle

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

Formats the value using the given formatter.

impl Display for ObjectHandle

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

Formats the value using the given formatter.

impl Hash for ObjectHandle

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ObjectHandle

fn eq(&self, other: &ObjectHandle) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ObjectHandle

impl Eq for ObjectHandle

impl Send for ObjectHandle

impl StructuralPartialEq for ObjectHandle

impl Sync for ObjectHandle