Struct diplomacy::order::Order

pub struct Order<L: Location, C: Command<L>> {
    pub nation: Nation,
    pub region: L,
    pub unit_type: UnitType,
    pub command: C,
}

An order is issued by a nation and gives a command to a unit in a region.

Fields

nation: Nation

The nation to which the commanded unit (or province) belongs.

region: L

The region in which the addressed unit resides (except for build commands).

unit_type: UnitType

The type of unit addressed.

command: C

The command dispatched to the order's region.

Implementations

impl<L: Location, C: Command<L>> Order<L, C>

pub fn new(nation: Nation, unit_type: UnitType, region: L, command: C) -> Self

Create a new order.

pub fn unit_position(&self) -> UnitPosition<&L>

Trait Implementations

impl<L: Clone + Location, C: Clone + Command<L>> Clone for Order<L, C>

fn clone(&self) -> Order<L, C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<L: Location, C: Command<L>> Command<L> for Order<L, C>

fn move_dest(&self) -> Option<&L>

Get the destination this order moves to, or None if the order is not a move.

fn is_move(&self) -> bool

Gets whether or not the order attempts to move to another region.

fn is_move_to_province(&self, p: &L::Province) -> bool

impl<L: Location, C: Command<L>> Debug for Order<L, C>

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

Formats the value using the given formatter.

impl<L: Location, C: Command<L>> Display for Order<L, C>

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

Formats the value using the given formatter.

impl<L: Eq + Location, C: Eq + Command<L>> Eq for Order<L, C>

impl<'a, L: Location, C: Command<L>> From<&'a Order<L, C>> for Unit<'a>

fn from(order: &'a Order<L, C>) -> Self

Performs the conversion.

impl<'a, L: Location, C: Command<L>> From<&'a Order<L, C>> for UnitPosition<'a, &'a L>

fn from(order: &'a Order<L, C>) -> Self

Performs the conversion.

impl<L: Location + FromStr<Err = Error>, C: Command<L> + FromWords<Err = Error>> FromStr for Order<L, C>

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Error>

Parses a string s to return a value of this type.

impl<L: Hash + Location, C: Hash + Command<L>> Hash for Order<L, C>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<L: Ord + Location, C: Ord + Command<L>> Ord for Order<L, C>

fn cmp(&self, other: &Order<L, C>) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<L: PartialEq + Location, C: PartialEq + Command<L>> PartialEq<Order<L, C>> for Order<L, C>

fn eq(&self, other: &Order<L, C>) -> bool

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

fn ne(&self, other: &Order<L, C>) -> bool

This method tests for !=.

impl<L: Location> PartialEq<Order<L, MainCommand<L>>> for SupportedOrder<L>

fn eq(&self, other: &Order<L, MainCommand<L>>) -> 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<L: Location> PartialEq<Order<L, MainCommand<L>>> for ConvoyedMove<L>

fn eq(&self, rhs: &Order<L, MainCommand<L>>) -> 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<L: PartialOrd + Location, C: PartialOrd + Command<L>> PartialOrd<Order<L, C>> for Order<L, C>

fn partial_cmp(&self, other: &Order<L, C>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Order<L, C>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Order<L, C>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Order<L, C>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Order<L, C>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<L: Location, C: Command<L>> StructuralEq for Order<L, C>

impl<L: Location, C: Command<L>> StructuralPartialEq for Order<L, C>