fbsim-core 1.0.0-beta.2

A library for american football simulation
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

#![doc = include_str!("../../../docs/league/season/week.md")]
#[cfg(feature = "rocket_okapi")]
use rocket_okapi::okapi::schemars;
#[cfg(feature = "rocket_okapi")]
use rocket_okapi::okapi::schemars::JsonSchema;
use serde::{Serialize, Deserialize};

use crate::league::season::matchup::LeagueSeasonMatchup;

/// # `LeagueSeasonWeek` struct
///
/// A `LeagueSeasonWeek` represents a week of a football season
#[cfg_attr(feature = "rocket_okapi", derive(JsonSchema))]
#[cfg_attr(feature = "wasm", derive(tsify_next::Tsify))]
#[cfg_attr(feature = "wasm", tsify(into_wasm_abi, from_wasm_abi))]
#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Debug, Serialize, Deserialize)]
pub struct LeagueSeasonWeek {
    matchups: Vec<LeagueSeasonMatchup>
}

impl Default for LeagueSeasonWeek {
    /// Default constructor for the LeagueSeasonWeek struct
    ///
    /// ### Example
    /// ```
    /// use fbsim_core::league::season::week::LeagueSeasonWeek;
    ///
    /// let my_week = LeagueSeasonWeek::default();
    /// ```
    fn default() -> Self {
        LeagueSeasonWeek {
            matchups: Vec::new()
        }
    }
}

impl LeagueSeasonWeek {
    /// Constructor for the LeagueSeasonWeek struct, with the week containing
    /// no matchups
    ///
    /// ### Example
    /// ```
    /// use fbsim_core::league::season::week::LeagueSeasonWeek;
    ///
    /// let my_week = LeagueSeasonWeek::new();
    /// ```
    pub fn new() -> LeagueSeasonWeek {
        LeagueSeasonWeek::default()
    }

    /// Borrow the matchups for the week
    ///
    /// ### Example
    /// ```
    /// use fbsim_core::league::season::week::LeagueSeasonWeek;
    ///
    /// let my_week = LeagueSeasonWeek::new();
    /// let my_matchups = my_week.matchups();
    /// ```
    pub fn matchups(&self) -> &Vec<LeagueSeasonMatchup> {
        &self.matchups
    }

    /// Mutably borrow the matchups for the week
    ///
    /// ### Example
    /// ```
    /// use fbsim_core::league::season::week::LeagueSeasonWeek;
    ///
    /// let mut my_week = LeagueSeasonWeek::new();
    /// let mut my_matchups = my_week.matchups_mut();
    /// ```
    pub fn matchups_mut(&mut self) -> &mut Vec<LeagueSeasonMatchup> {
        &mut self.matchups
    }

    /// Determine based on the matchups whether the week has started
    ///
    /// ### Example
    /// ```
    /// use fbsim_core::league::season::week::LeagueSeasonWeek;
    ///
    /// let my_week = LeagueSeasonWeek::new();
    /// let started = my_week.started();
    /// ```
    pub fn started(&self) -> bool {
        // If no matchups, then the week hasn't started
        if self.matchups.is_empty() {
            return false;
        }

        // Loop through the matchups and check if any are complete
        for matchup in self.matchups.iter() {
            if matchup.context().game_over() {
                return true;
            }
        }
        false
    }

    /// Determine based on the matchups whether the week has completed
    ///
    /// ### Example
    /// ```
    /// use fbsim_core::league::season::week::LeagueSeasonWeek;
    ///
    /// let my_week = LeagueSeasonWeek::new();
    /// let complete = my_week.complete();
    /// ```
    pub fn complete(&self) -> bool {
        // If no matchups, then the week hasn't started
        if self.matchups.is_empty() {
            return false;
        }

        // Loop through the matchups and check if any are not complete
        for matchup in self.matchups.iter() {
            if !matchup.context().game_over() {
                return false;
            }
        }
        true
    }

    /// Get a matchup involving a team
    pub fn team_matchup(&self, id: usize) -> Option<LeagueSeasonMatchup> {
        for matchup in self.matchups.iter() {
            if matchup.participated(id) {
                return Some(matchup.clone());
            }
        }
        None
    }
}