Struct actix_lua::LuaActor

source ·
pub struct LuaActor {
    pub recipients: HashMap<String, Recipient<LuaMessage>>,
    /* private fields */
}
Expand description

Top level struct which holds a lua state for itself.

It provides most of the actix context API to the lua enviroment.

You can create new LuaActor with LuaActorBuilder.

ctx.msg

The message sent to Lua actor.

ctx.notify(msg)

Send message msg to self.

ctx.notify_later(msg, seconds)

Send message msg to self after specified period of time.

local recipient = ctx.new_actor(script_path, [actor_name])

Create a new actor with given lua script. returns a recipient which can be used in ctx.send and ctx.do_send.

local result = ctx.send(recipient, msg)

Send message msg to `recipient asynchronously and wait for response.

Equivalent to actix::Recipient.send.

ctx.do_send(recipient, msg)

Send message msg to recipient.

Equivalent to actix::Recipient.do_send.

ctx.terminate()

Terminate actor execution.

Fields

recipients: HashMap<String, Recipient<LuaMessage>>

Implementations

Add a recipient to the actor’s recipient list. You can send message to the recipient via name with the context API ctx.send(name, message)

Trait Implementations

Actor execution context type
Method is called when actor get polled first time.
Method is called after an actor is stopped, it can be used to perform any needed cleanup work or spawning more actors. This is final state, after this call actor get dropped. Read more
Method is called after an actor is in Actor::Stopping state. There could be several reasons for stopping. Context::stop get called by the actor itself. All addresses to current actor get dropped and no more evented objects left in the context. Read more
Start new asynchronous actor, returns address of newly created actor. Read more
Use create method, if you need Context object during actor initialization. Read more
The type of value that this handle will return
Method is called for every message received by this Actor

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

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

The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.