rust_sc2::bot

Struct CountOptions

Source
pub struct CountOptions<'a> {
    pub completion: Completion,
    pub alias: UnitAlias,
    /* private fields */
}
Expand description

Options used to configure which units are counted. Constructed with counter and enemy_counter methods.

Fields§

§completion: Completion

State of counted units. Can be:

  • Complete - only complete units
  • Ordered - only units in progress
  • All - both compete and ordered units

[Default: Complete]

§alias: UnitAlias

Alias of counted units. Can be:

  • None - don’t count alias
  • Unit - count unit-alias, used when unit has 2 forms
  • Tech - count tech-alias, used when unit has more than 2 forms (usually structures)

[Default: None]

Implementations§

Source§

impl<'a> CountOptions<'a>

Source

pub fn ordered(&mut self) -> &mut Self

Sets completion to Ordered.

Source

pub fn all(&mut self) -> &mut Self

Sets completion to All.

Source

pub fn alias(&mut self) -> &mut Self

Sets alias to Unit.

Source

pub fn tech(&mut self) -> &mut Self

Sets alias to Tech.

Source

pub fn count(&self, unit_id: UnitTypeId) -> usize

Counts units of given type and returns the result.

Trait Implementations§

Source§

impl<'a> Clone for CountOptions<'a>

Source§

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

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CountOptions<'_>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> Copy for CountOptions<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for CountOptions<'a>

§

impl<'a> !RefUnwindSafe for CountOptions<'a>

§

impl<'a> !Send for CountOptions<'a>

§

impl<'a> !Sync for CountOptions<'a>

§

impl<'a> Unpin for CountOptions<'a>

§

impl<'a> !UnwindSafe for CountOptions<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V