Struct ActorServer

pub struct ActorServer<Actor, Message, State, Response, Error> { /* private fields */ }

ActorServer is a structure that represents a server for actors. It contains a reference to an actor.

Type Parameters

• Actor: The type of the actor that this server is hosting.
• Message: The type of the messages that the actor can handle.
• State: The type of the state that the actor maintains.
• Response: The type of the response that the actor produces when handling a message.
• Error: The type of the error that the actor can produce when handling a message.

Fields

• actor_ref: A mutex protecting an optional reference to the actor. This allows the actor to be safely shared between multiple threads.
• failed: …

Trait Implementations

impl<Actor: Handler<Actor = Actor, State = State, Message = Message, Error = Error, Response = Response> + SSSDED, Message: SSSDED, State: SSSDED, Response: SSSDED, Error: SSSDED + Error + From<Error> + 'static> ActorServerTrait for ActorServer<Actor, Message, State, Response, Error>

async fn new( name: impl AsRef<str>, host: impl AsRef<str>, port: u16, actor: Arc<ActorRef<Actor, Message, State, Response, Error>>, ) -> Result<Arc<Self>, Error>

Creates a new instance of ActorServer.

Arguments

• name - A string slice that holds the name of the actor server.
• host - A string slice that holds the host of the actor server.
• port - A 16-bit unsigned integer that represents the port on which the actor server will run.
• actor - An Arc reference to an ActorRef object.

Returns

• Result<Arc<Self>, Error> - Returns a new instance of ActorServer wrapped in an Arc. If an error occurs, it returns an Error.

Errors

This function will return an error if the TCP listener fails to bind to the provided address.

async fn stop(&self) -> Result<(), Error>

Stops the ActorServer.

This method attempts to stop the actor referenced by this server. If the actor reference exists, it will call the stop method on the actor. After attempting to stop the actor, it sets the actor reference to None.

Returns

• Result<(), Error> - Returns an empty Result if the operation is successful. If an error occurs while stopping the actor, it returns an Error.

Errors

This function will return an error if the actor fails to stop.

type Actor = Actor

type Message = Message

type State = State

type Response = Response

type Error = Error

impl<Actor: Debug, Message: Debug, State: Debug, Response: Debug, Error: Debug> Debug for ActorServer<Actor, Message, State, Response, Error>

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

Formats the value using the given formatter.