Struct livesplit_core::SegmentHistory

pub struct SegmentHistory(_);

Stores the segment times achieved for a certain segment. Each segment is tagged with an index. Only segment times with an index larger than 0 are considered times actually achieved by the runner, while the others are artifacts of route changes and similar algorithmic changes.

Methods

impl SegmentHistory

pub fn try_get_min_index(&self) -> Option<i32>

Returns the minimum index of all the segment times. Returns None if there's no segment times in this history.

pub fn min_index(&self) -> i32

Returns the minimum index of all the segment times. If there's no segment times or the minimum is less than 1, 1 is returned instead.

pub fn try_get_max_index(&self) -> Option<i32>

Returns the maximum index of all the segment times. Returns None if there's no segment times in this history.

pub fn insert(&mut self, index: i32, time: Time)

Inserts a new segment time into the Segment History, with the index provided. If there's already a segment time with that index, the time is not inserted.

pub fn get(&self, index: i32) -> Option<Time>

Accesses the segment time with the given index. If there's no segment time with that index, None is returned instead.

pub fn get_mut(&mut self, index: i32) -> Option<&mut Time>

Grants mutable access to the segment time with the given index. If there's no segment time with that index, None is returned instead.

pub fn remove(&mut self, index: i32)

Removes the segment time with the given index. If it doesn't exist, nothing is done.

pub fn clear(&mut self)

Removes all the segment times from the Segment History.

pub fn retain<F>(&mut self, f: F) where
    F: FnMut(&(i32, Time)) -> bool, 

Removes all the segment times from the Segment History, where the given closure returns false.

pub fn iter(&self) -> Iter<(i32, Time)>

Iterates over all the segment times and their indices.

pub fn iter_mut(&mut self) -> IterMut<(i32, Time)>

Mutably iterates over all the segment times and their indices.

Warning

While you are allowed to change the indices, you need to ensure they stay in rising order.

pub fn iter_actual_runs(&self) -> Iter<(i32, Time)>

Iterates over the actual segment times achieved by the runner. Segment times created by route changes or other algorithmic changes are filtered out.

Trait Implementations

impl Default for SegmentHistory

fn default() -> SegmentHistory

Returns the "default value" for a type.

impl Clone for SegmentHistory

fn clone(&self) -> SegmentHistory

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<SegmentHistory> for SegmentHistory

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

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

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

This method tests for !=.

impl<'a> IntoIterator for &'a SegmentHistory

type Item = &'a (i32, Time)

The type of the elements being iterated over.

type IntoIter = Iter<'a, (i32, Time)>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Iter<'a, (i32, Time)>

Creates an iterator from a value.

impl Debug for SegmentHistory

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

Formats the value using the given formatter.