Enum diplomacy::judge::retreat::OrderOutcome

pub enum OrderOutcome<'a> {
    Prevented(&'a MappedRetreatOrder),
    InvalidDestination(DestStatus),
    InvalidRecipient,
    Moves,
    DisbandsAsOrdered,
}

The outcome of a specific retreat phase order.

Variants

Prevented(&'a MappedRetreatOrder)

The order was prevented by one or more other retreat orders.

InvalidDestination(DestStatus)

The order destination was invalid. The DestStatus provides information on why the destination was invalid.

InvalidRecipient

The order was issued to a region that does not contain a retreating unit.

The region may be vacant, or may contain a unit that was not dislodged.

Moves

The unit successfully retreats to a new region

DisbandsAsOrdered

The unit was ordered to disband and did so.

Implementations

impl<'_> OrderOutcome<'_>

pub fn did_disband(&self) -> bool

Check if the ordered unit disbanded at the conclusion of the retreat phase.

Trait Implementations

impl<'a> Clone for OrderOutcome<'a>

fn clone(&self) -> OrderOutcome<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for OrderOutcome<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for OrderOutcome<'a>

impl<'_> PartialEq<DestStatus> for OrderOutcome<'_>

Most DestStatus values block a retreat-phase move order from succeeding or exerting influence on the move destination. These values can appear in the InvalidDestination variant of OrderOutcome. Note that DestStatus::Available will never equal an order outcome.

fn eq(&self, other: &DestStatus) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_> PartialEq<OrderOutcome<'_>> for DestStatus

fn eq(&self, other: &OrderOutcome) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialEq<OrderOutcome<'a>> for OrderOutcome<'a>

fn eq(&self, other: &OrderOutcome<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &OrderOutcome<'a>) -> bool

This method tests for !=.

impl<'a> StructuralEq for OrderOutcome<'a>

impl<'a> StructuralPartialEq for OrderOutcome<'a>