Skip to main content

WorldManager

Struct WorldManager 

Source
pub struct WorldManager { /* private fields */ }
Expand description

Manages World state with concurrent access support.

WorldManager owns the World and processes state modifications through a command queue. This enables multiple ChannelRunners to modify the World without holding locks.

§Thread Safety

  • Reads: Via Arc<RwLock<World>> clone (parallel reads allowed)
  • Writes: Via command queue (sequential, no contention)

§Example

let (manager, cmd_tx) = WorldManager::new();

// Clone for read access
let world_read = manager.world();

// Spawn the manager loop
tokio::spawn(manager.run());

// Send commands
cmd_tx.send(WorldCommand::Kill { id, reason }).await?;

Implementations§

Source§

impl WorldManager

Source

pub fn new() -> (Self, WorldCommandSender)

Creates a new WorldManager with an empty World.

Returns the manager and a sender for commands.

§Example
let (manager, cmd_tx) = WorldManager::new();
tokio::spawn(manager.run());
Source

pub fn with_world(world: World) -> (Self, WorldCommandSender)

Creates a WorldManager with an existing World.

Use this when you need to initialize the World before starting the manager (e.g., creating the IO channel).

§Example
let mut world = World::new();
let io = world.create_channel(ChannelConfig::interactive());

let (manager, cmd_tx) = WorldManager::with_world(world);
Source

pub fn world(&self) -> Arc<RwLock<World>>

Returns a clone of the World handle for read access.

The returned Arc<RwLock<World>> can be shared across tasks for concurrent read access.

Source

pub async fn run(self)

Runs the command processing loop.

This method consumes the manager and runs until:

  • A Shutdown command is received
  • All command senders are dropped (channel closed)
§Example
let (manager, cmd_tx) = WorldManager::new();
let handle = tokio::spawn(manager.run());

// ... use cmd_tx ...

cmd_tx.send(WorldCommand::Shutdown).await?;
handle.await?;

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more