Enum AgentKind

pub enum AgentKind {
    Player(Player),
    Gadget(Gadget),
    Character(Character),
}

The type of an agent.

arcdps differentiates between three types of agents: Player, Character and Gadget. This enum unifies handling between them by allowing you to pattern match or use one of the accessor methods.

The main way to obtain a AgentKind is by using the .kind() method on an Agent. In cases where you already have a raw::Agent available, you can also use the TryFrom/TryInto traits to convert a raw::Agent or &raw::Agent to a AgentKind:

use std::convert::TryInto;
// Get a raw::Agent from somewhere
let raw_agent: raw::Agent = panic!();
// Convert it
let agent: AgentKind = raw_agent.try_into().unwrap();

Variants

Player(Player)

The agent is a player.

The player-specific data is in the included Player struct.

Gadget(Gadget)

The agent is a gadget.

The gadget-specific data is in the included Gadget struct.

Character(Character)

The agent is a character.

The character-specific data is in the included Character struct.

Implementations

impl AgentKind

pub fn as_player(&self) -> Option<&Player>

Accesses the inner Player struct, if available.

pub fn is_player(&self) -> bool

Determines whether this AgentKind contains a player.

pub fn as_gadget(&self) -> Option<&Gadget>

Accesses the inner Gadget struct, if available.

pub fn is_gadget(&self) -> bool

Determines whether this AgentKind contains a gadget.

pub fn as_character(&self) -> Option<&Character>

Accesses the inner Character struct, if available.

pub fn is_character(&self) -> bool

Determines whether this AgentKind contains a character.

Trait Implementations

impl Clone for AgentKind

fn clone(&self) -> AgentKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AgentKind

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

Formats the value using the given formatter.

impl Hash for AgentKind

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for AgentKind

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&Agent> for AgentKind

fn try_from(raw_agent: &Agent) -> Result<Self, Self::Error>

Extract the correct AgentKind from the given raw agent.

This automatically discerns between player, gadget and characters.

Note that in most cases, you probably want to use Agent::try_from or even process instead of this function.

type Error = EvtcError

The type returned in the event of a conversion error.

impl TryFrom<Agent> for AgentKind

fn try_from(raw_agent: Agent) -> Result<Self, Self::Error>

Convenience method to avoid manual borrowing.

Note that this conversion will consume the agent, so if you plan on re-using it, use the TryFrom<&raw::Agent> implementation that works with a reference.

type Error = EvtcError

The type returned in the event of a conversion error.

impl Eq for AgentKind

impl StructuralPartialEq for AgentKind