Struct EntityResource 

pub struct EntityResource<T> { /* private fields */ }

A resource that survives entity restarts (shard movement, crash recovery).

When an entity handler is respawned due to a crash, the EntityResource is NOT closed — only the handler is recreated. The resource is only closed on explicit close() or when the entity is reaped.

While an EntityResource is active (not closed), the entity’s on_idle() should return true to prevent idle reaping. Use is_active() to check.

Example

let resource = EntityResource::new(MyConnection::new().await?);
// Use the resource
let conn = resource.read().await;
conn.query("SELECT 1").await?;
// Check if active for keep-alive
if resource.is_active() {
    // Entity should not be reaped
}
// Explicit close when done
resource.close().await;

Implementations

impl<T> EntityResource<T>

pub fn new(value: T) -> Self

Create a new entity resource wrapping the given value.

pub fn is_active(&self) -> bool

Returns true if the resource has not been closed.

pub async fn read(&self) -> Option<RwLockReadGuard<'_, Option<T>>>

Read access to the resource value.

Returns None if the resource has been closed.

pub async fn write(&self) -> Option<RwLockWriteGuard<'_, Option<T>>>

Write access to the resource value.

Returns None if the resource has been closed.

pub async fn close(&self)

Close the resource, dropping the inner value and marking it inactive.

After closing, is_active() returns false and read()/write() return None. The entity can then be reaped on idle.

pub fn close_token(&self) -> CancellationToken

Returns a CancellationToken that is cancelled when the resource is closed. Useful for tying background tasks to the resource lifetime.

Trait Implementations

impl<T> Clone for EntityResource<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.