Struct evtclib::Log

pub struct Log { /* private fields */ }

A fully processed log file.

Implementations

impl Log

pub fn agents(&self) -> &[Agent]

Return all agents present in this log.

pub fn agent_by_addr(&self, addr: u64) -> Option<&Agent>

Return an agent based on its address.

pub fn agent_by_instance_id(&self, instance_id: u16) -> Option<&Agent>

Return an agent based on the instance ID.

pub fn master_agent(&self, addr: u64) -> Option<&Agent>

Return the master agent of the given agent.

• addr - The address of the agent which to get the master for.

pub fn players(&self) -> impl Iterator<Item = &Agent<Player>>

Return an iterator over all agents that represent player characters.

pub fn characters(&self) -> impl Iterator<Item = &Agent<Character>>

Return an iterator over all agents that are characters.

pub fn gadgets(&self) -> impl Iterator<Item = &Agent<Gadget>>

Return an iterator over all agents that are gadgets.

pub fn boss(&self) -> &Agent

Return the boss agent.

Be careful with encounters that have multiple boss agents, such as Trio and Xera.

Panics

This function will panic if the boss agent cannot be found. For a more failsafe version, see Log::boss_agents.

pub fn boss_agents(&self) -> Vec<&Agent>

Return all boss agents.

This correctly returns multiple agents on encounters where multiple agents are needed.

pub fn is_boss(&self, addr: u64) -> bool

Check whether the given address is a boss agent.

pub fn encounter_id(&self) -> u16

Returns the encounter id.

pub fn encounter(&self) -> Option<Encounter>

Returns the encounter, if present.

Some logs don’t have an encounter set or have an ID that is unknown to us (for example, if people set up arcdps with custom IDs). Therefore, this method can only return the encounter if we know about it in Encounter.

pub fn analyzer<'s>(&'s self) -> Option<Box<dyn Analyzer + 's>>

Return an analyzer suitable to analyze the given log.

pub fn events(&self) -> &[Event]

Return all events present in this log.

pub fn span(&self) -> u64

Returns the timespan of the log in milliseconds.

The timespan is the time between the first registered event and the last registered event, measured in milliseconds.

Note that this does not necessarily equate to the fight/encounter duration, as arcdps starts logging as soon as you enter combat, but some bosses are still invulnerable (e.g. Ensolyss). It does however give a good idea and is cheap to compute.

In the rare occassions that a log does not have any events, this function will return 0.

pub fn is_generic(&self) -> bool

Check whether this log represents a “generic” log.

A generic log is a log that is not tied to a specific boss ID, but rather is triggered by squad members entering and leaving combat. This is for example the case in WvW logs, which can be identified using this function.

Note that many of the analyzing functions (such as Log::was_rewarded) do not have sensible results for generic functions.

pub fn game_mode(&self) -> Option<GameMode>

Returns the game mode that the log was made in.

Note that if the game mode cannot be determined or is unknown to evtclib, None is returned.

impl Log

Convenience data accessing funtions for Logs.

The information that is gathered by those functions is “expensive” to compute, as we have to loop through every event. They are not saved in the header, and instead are implemented using special EventKinds. This is not a limitation of evtclib, but rather a result of how arcdps stores the data.

This also means that those functions are fallible because we cannot guarantee that the special events that we’re looking for is actually present in every log file.

Use those functions only if necessary, and prefer to cache the result if it will be reused!

pub fn is_cm(&self) -> bool

Check whether the fight was done with challenge mote activated.

This function always returns false if

• The fight was done without CM
• The fight does not have a CM
• We cannot determine whether the CM was active
• The boss is not known

pub fn local_start_timestamp(&self) -> Option<u32>

Get the timestamp of when the log was started.

The returned value is a unix timestamp in the local time zone.

If the LogStart event cannot be found, this function returns None.

pub fn local_end_timestamp(&self) -> Option<u32>

Get the timestamp of when the log was ended.

The returned value is a unix timestamp in the local time zone.

If the LogEnd event cannot be found, this function returns None.

pub fn was_rewarded(&self) -> bool

Check if rewards for this fight have been given out.

This can be used as an indication whether the fight was successful (true) or not (false).

If you want to properly determine whether a fight was successful, check the Analyzer::outcome method, which does more sophisticated checks (dependent on the boss).

pub fn errors(&self) -> Vec<&str>

Returns all error strings that were captured.

If no errors were encountered, an empty vec is returned.

Note that those are errors reported verbatim by arcdps, nothing that evtclib produces/interprets.

pub fn build_id(&self) -> Option<u64>

Returns the game’s build id.

If no build id was found, None is returned.

Trait Implementations

impl Clone for Log

fn clone(&self) -> Log

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Log

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

Formats the value using the given formatter.