Struct livesplit_core::run::Segment

pub struct Segment { /* private fields */ }

A Segment describes a point in a speedrun that is suitable for storing a split time. This stores the name of that Segment, an icon, the split times of different comparisons, and a history of segment times.

Examples

use livesplit_core::{Segment, Time, TimeSpan};

let mut segment = Segment::new("Metro Kingdom");

let time = Time::new().with_real_time(Some(TimeSpan::from_seconds(234.0)));
segment.set_personal_best_split_time(time);

Implementations

impl Segment

pub fn new<S>(name: S) -> Selfwhere
    S: Into<String>,

Creates a new Segment with the name given.

pub fn name(&self) -> &str

Accesses the name of the segment.

pub fn set_name<S>(&mut self, name: S)where
    S: PopulateString,

Sets the name of the segment.

pub const fn icon(&self) -> &Image

Accesses the icon of the segment.

pub fn set_icon<D: Into<Image>>(&mut self, image: D)

Sets the icon of the segment.

pub fn comparisons_mut(&mut self) -> &mut Comparisons

Grants mutable access to the comparison times stored in the Segment. This includes both the custom comparisons and the generated ones.

pub fn comparison_mut(&mut self, comparison: &str) -> &mut Time

Grants mutable access to the specified comparison’s time. If there’s none for this comparison, a new one is inserted with an empty time.

pub fn comparison(&self, comparison: &str) -> Time

Accesses the specified comparison’s time. If there’s none for this comparison, an empty time is being returned (but not stored in the segment).

pub fn comparison_timing_method(
    &self,
    comparison: &str,
    method: TimingMethod
) -> Option<TimeSpan>

Accesses the given timing method of the specified comparison. If either the TimeSpan is empty or the comparison has no stored time, None is returned.

pub fn personal_best_split_time(&self) -> Time

Accesses the split time of the Personal Best for this segment. If it doesn’t exist, an empty time is returned.

pub fn personal_best_split_time_mut(&mut self) -> &mut Time

Grants mutable access to the split time of the Personal Best for this segment. If it doesn’t exist an empty time is inserted.

pub fn set_personal_best_split_time(&mut self, time: Time)

Sets the split time of the Personal Best to the time provided.

pub const fn best_segment_time(&self) -> Time

Accesses the Best Segment Time.

pub fn best_segment_time_mut(&mut self) -> &mut Time

Grants mutable access to the Best Segment Time.

pub fn set_best_segment_time(&mut self, time: Time)

Sets the Best Segment Time.

pub const fn split_time(&self) -> Time

Accesses the split time of the current attempt.

pub fn split_time_mut(&mut self) -> &mut Time

Grants mutable access to the split time of the current attempt.

pub fn set_split_time(&mut self, time: Time)

Sets the split time of the current attempt.

pub fn clear_split_time(&mut self)

Clears the split time of the current attempt.

pub const fn segment_history(&self) -> &SegmentHistory

Accesses the Segment History of this segment.

pub fn segment_history_mut(&mut self) -> &mut SegmentHistory

Grants mutable access to the Segment History of this segment.

pub const fn variables(&self) -> &HashMap<String, String>

Accesses the segment’s variables for the current attempt.

pub fn variables_mut(&mut self) -> &mut HashMap<String, String>

Grants mutable access to the segment’s variables for the current attempt.

pub fn clear_variables(&mut self)

Clears the variables of the current attempt.

pub fn clear_split_info(&mut self)

Clears all the information the segment stores when it has been splitted, such as the split’s time and variables.

Trait Implementations

impl Clone for Segment

fn clone(&self) -> Segment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Segment

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

Formats the value using the given formatter.

impl Default for Segment

fn default() -> Segment

Returns the “default value” for a type.

impl PartialEq<Segment> for Segment

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

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

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

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

impl StructuralPartialEq for Segment