Struct Agent

Source
pub struct Agent<S: Strategy> { /* private fields */ }
Expand description

The core event-driven Agent program. Defines the workflow of the agent.

The Agent creates and manages an ECS World, manages AgentEvents sent from EventSources, and dispatches them.

§Type parameters

  • S: Strategy type, representing the Agent’s action selection strategy.

§Compatibility

  • WASM: compatible.

Implementations§

Source§

impl<S: Strategy> Agent<S>

Source

pub fn new(strategy: S) -> Self

Create a new agent.

Source

pub fn spawn_event_source<E: EventSource + Send + 'static>( &mut self, event_source: E, on_finish: OnFinish, )

Spawn an event source for the agent.

§Spawns

Spawns a new tokio thread for the event source.

§Compatibility
  • WASM: compatible with tokio_with_wasm
Source

pub fn add_system<SS: System>(&mut self, system: SS)

Add a system to the agent.

Source

pub async fn run(&mut self)

The function to run the agent.

run dispatches AgentEvents into the ECS World based on the Agent’s strategy.

Auto Trait Implementations§

§

impl<S> !Freeze for Agent<S>

§

impl<S> !RefUnwindSafe for Agent<S>

§

impl<S> !Send for Agent<S>

§

impl<S> !Sync for Agent<S>

§

impl<S> Unpin for Agent<S>
where S: Unpin,

§

impl<S> !UnwindSafe for Agent<S>

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