Enum OrchestratorToPlanet 

pub enum OrchestratorToPlanet {
    Sunray(Sunray),
    Asteroid(Asteroid),
    StartPlanetAI,
    StopPlanetAI,
    KillPlanet,
    InternalStateRequest,
    IncomingExplorerRequest {
        explorer_id: ID,
        new_sender: Sender<PlanetToExplorer>,
    },
    OutgoingExplorerRequest {
        explorer_id: ID,
    },
}

This enum describes all possible messages from the Orchestrator to a Planet

Variants

Sunray(Sunray)

This variant is used to send a Sunray to a planet

Expected Response: PlanetToOrchestrator::SunrayAck

Use Case: sending a Sunray to charge EnergyCell

Asteroid(Asteroid)

This variant is used to send an Asteroid to a planet

Expected Response: PlanetToOrchestrator::AsteroidAck

Use Case: sending an Asteroid to attack a Planet

StartPlanetAI

This variant is used to start a Planet AI and restart it if it is stopped

Expected Response: PlanetToOrchestrator::StartPlanetAIResult

Use Case: Starting the Planet AI at game start or restart the AI in case it is stopped

StopPlanetAI

This variant is used to pause the planet Ai

Expected Response: PlanetToOrchestrator::StopPlanetAIResult

Use Case: Freezing Planet ability to respond to every message, a planet in this state will only answer with PlanetToOrchestrator::Stopped

KillPlanet

This variant is used to kill (or destroy) the planet

Expected Response: PlanetToOrchestrator::KillPlanetResult

Use Case: Instantly kill a Planet

InternalStateRequest

This variant is used to obtain a Planet Internal State

Expected Response: PlanetToOrchestrator::InternalStateResponse

Use Case: The GUI can use this message to obtain the relevant info of the planet to be shown

IncomingExplorerRequest

This variant is used to advertise an incoming explorer to a planet

Expected Response: PlanetToOrchestrator::IncomingExplorerResponse

Use Case: Moving an explorer to this planet

Fields

explorer_id: ID

The incoming explorer’s id

new_sender: Sender<PlanetToExplorer>

The new sender half of the crossbeam_channel for the planet to communicate with the incoming explorer

OutgoingExplorerRequest

This variant is used to advertise an outgoing explorer to a planet

Expected Response: PlanetToOrchestrator::OutgoingExplorerResponse

Use Case: Asking the planet to delete the Sender to the outgoing explorer

Fields

explorer_id: ID

The outgoing explorer’s id

Implementations

impl OrchestratorToPlanet

pub fn is_sunray(&self) -> bool

Returns true if this is a OrchestratorToPlanet::Sunray, otherwise false

pub fn as_sunray_mut(&mut self) -> Option<&mut Sunray>

Optionally returns mutable references to the inner fields if this is a OrchestratorToPlanet::Sunray, otherwise None

pub fn as_sunray(&self) -> Option<&Sunray>

Optionally returns references to the inner fields if this is a OrchestratorToPlanet::Sunray, otherwise None

pub fn into_sunray(self) -> Result<Sunray, Self>

Returns the inner fields if this is a OrchestratorToPlanet::Sunray, otherwise returns back the enum in the Err case of the result

pub fn is_asteroid(&self) -> bool

Returns true if this is a OrchestratorToPlanet::Asteroid, otherwise false

pub fn as_asteroid_mut(&mut self) -> Option<&mut Asteroid>

Optionally returns mutable references to the inner fields if this is a OrchestratorToPlanet::Asteroid, otherwise None

pub fn as_asteroid(&self) -> Option<&Asteroid>

Optionally returns references to the inner fields if this is a OrchestratorToPlanet::Asteroid, otherwise None

pub fn into_asteroid(self) -> Result<Asteroid, Self>

Returns the inner fields if this is a OrchestratorToPlanet::Asteroid, otherwise returns back the enum in the Err case of the result

pub fn is_start_planet_ai(&self) -> bool

Returns true if this is a OrchestratorToPlanet::StartPlanetAI, otherwise false

pub fn is_stop_planet_ai(&self) -> bool

Returns true if this is a OrchestratorToPlanet::StopPlanetAI, otherwise false

pub fn is_kill_planet(&self) -> bool

Returns true if this is a OrchestratorToPlanet::KillPlanet, otherwise false

pub fn is_internal_state_request(&self) -> bool

Returns true if this is a OrchestratorToPlanet::InternalStateRequest, otherwise false

pub fn is_incoming_explorer_request(&self) -> bool

Returns true if this is a OrchestratorToPlanet::IncomingExplorerRequest, otherwise false

pub fn as_incoming_explorer_request_mut( &mut self, ) -> Option<(&mut ID, &mut Sender<PlanetToExplorer>)>

Optionally returns mutable references to the inner fields if this is a OrchestratorToPlanet::IncomingExplorerRequest, otherwise None

pub fn as_incoming_explorer_request( &self, ) -> Option<(&ID, &Sender<PlanetToExplorer>)>

Optionally returns references to the inner fields if this is a OrchestratorToPlanet::IncomingExplorerRequest, otherwise None

pub fn into_incoming_explorer_request( self, ) -> Result<(ID, Sender<PlanetToExplorer>), Self>

Returns the inner fields if this is a OrchestratorToPlanet::IncomingExplorerRequest, otherwise returns back the enum in the Err case of the result

pub fn is_outgoing_explorer_request(&self) -> bool

Returns true if this is a OrchestratorToPlanet::OutgoingExplorerRequest, otherwise false

pub fn as_outgoing_explorer_request_mut(&mut self) -> Option<&mut ID>

Optionally returns mutable references to the inner fields if this is a OrchestratorToPlanet::OutgoingExplorerRequest, otherwise None

pub fn as_outgoing_explorer_request(&self) -> Option<&ID>

Optionally returns references to the inner fields if this is a OrchestratorToPlanet::OutgoingExplorerRequest, otherwise None

pub fn into_outgoing_explorer_request(self) -> Result<ID, Self>

Returns the inner fields if this is a OrchestratorToPlanet::OutgoingExplorerRequest, otherwise returns back the enum in the Err case of the result

Trait Implementations

impl Debug for OrchestratorToPlanet

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

Formats the value using the given formatter.

impl<'_enum> From<&'_enum OrchestratorToPlanet> for OrchestratorToPlanetKind

fn from(val: &'_enum OrchestratorToPlanet) -> OrchestratorToPlanetKind

Converts to this type from the input type.

impl From<OrchestratorToPlanet> for OrchestratorToPlanetKind

fn from(val: OrchestratorToPlanet) -> OrchestratorToPlanetKind

Converts to this type from the input type.

impl IntoDiscriminant for OrchestratorToPlanet

type Discriminant = OrchestratorToPlanetKind

Enum listing the same variants as this enum but without any data fields

fn discriminant(&self) -> Self::Discriminant