livesplit-core 0.13.0

#![warn(
    clippy::complexity,
    clippy::correctness,
    clippy::perf,
    clippy::style,
    clippy::missing_const_for_fn,
    clippy::undocumented_unsafe_blocks,
    missing_docs,
    rust_2018_idioms
)]
// Clippy false positives
#![allow(
    clippy::blocks_in_if_conditions,
    clippy::redundant_closure_call,
    clippy::new_ret_no_self
)]
#![cfg_attr(not(feature = "std"), no_std)]

//! livesplit-core is a library that provides a lot of functionality for creating a speedrun timer.
//!
//! # Examples
//!
//! ```
//! use livesplit_core::{Run, Segment, Timer, TimerPhase};
//!
//! // Create a run object that we can use with at least one segment.
//! let mut run = Run::new();
//! run.set_game_name("Super Mario Odyssey");
//! run.set_category_name("Any%");
//! run.push_segment(Segment::new("Cap Kingdom"));
//!
//! // Create the timer from the run.
//! let mut timer = Timer::new(run).expect("Run with at least one segment provided");
//!
//! // Start a new attempt.
//! timer.start();
//! assert_eq!(timer.current_phase(), TimerPhase::Running);
//!
//! // Create a split.
//! timer.split();
//!
//! // The run should be finished now.
//! assert_eq!(timer.current_phase(), TimerPhase::Ended);
//!
//! // Reset the attempt and confirm that we want to store the attempt.
//! timer.reset(true);
//!
//! // The attempt is now over.
//! assert_eq!(timer.current_phase(), TimerPhase::NotRunning);
//! ```

extern crate alloc;

mod platform;

macro_rules! catch {
    ($($code:tt)*) => {
        (|| { Some({ $($code)* }) })()
    }
}

pub mod analysis;
#[cfg(feature = "auto-splitting")]
pub mod auto_splitting;
pub mod comparison;
pub mod component;
#[cfg(feature = "std")]
mod hotkey_config;
#[cfg(feature = "std")]
mod hotkey_system;
pub mod layout;
#[cfg(feature = "networking")]
pub mod networking;
#[cfg(feature = "rendering")]
pub mod rendering;
pub mod run;
pub mod settings;
pub mod timing;
pub mod util;

pub use crate::{
    layout::{Component, Editor as LayoutEditor, GeneralSettings as GeneralLayoutSettings, Layout},
    platform::DateTime,
    run::{Attempt, Editor as RunEditor, Run, RunMetadata, Segment, SegmentHistory},
    timing::{
        AtomicDateTime, GameTime, RealTime, Time, TimeSpan, TimeStamp, Timer, TimerPhase,
        TimingMethod,
    },
};
pub use livesplit_hotkey as hotkey;

#[cfg(not(feature = "std"))]
pub use crate::platform::{register_clock, Clock, Duration};

#[cfg(feature = "std")]
pub use crate::{hotkey_config::HotkeyConfig, hotkey_system::HotkeySystem, timing::SharedTimer};