Struct FootballTeam 

pub struct FootballTeam { /* private fields */ }

FootballTeam struct

A FootballTeam represents a football team

Implementations

impl FootballTeam

pub fn new() -> FootballTeam

Constructor for the FootballTeam struct in which each overall is defaulted to 50_i32, and the name is defaulted

Example

use fbsim_core::team::FootballTeam;

let my_team = FootballTeam::new();

pub fn from_overalls( name: &str, short_name: &str, offense_overall: u32, defense_overall: u32, ) -> Result<FootballTeam, String>

Constructor for the FootballTeam struct in which an offense and defense are constructed given their overalls

Example

use fbsim_core::team::FootballTeam;

let my_team = FootballTeam::from_overalls("My Team", "TEAM", 25, 75);

pub fn from_properties( name: &str, short_name: &str, coach: FootballTeamCoach, offense: FootballTeamOffense, defense: FootballTeamDefense, ) -> FootballTeam

Constructor for the FootballTeam struct in which each property is given as an argument.

Example

use fbsim_core::team::FootballTeam;
use fbsim_core::team::coach::FootballTeamCoach;
use fbsim_core::team::offense::FootballTeamOffense;
use fbsim_core::team::defense::FootballTeamDefense;

let my_coach = FootballTeamCoach::new();
let my_defense = FootballTeamDefense::new();
let my_offense = FootballTeamOffense::new();
let my_team = FootballTeam::from_properties("My Team", "TEAM", my_coach, my_offense, my_defense);

pub fn name(&self) -> &str

Get the football team’s name

Example

use fbsim_core::team::FootballTeam;

let my_team = FootballTeam::new();
let name = my_team.name();

pub fn name_mut(&mut self) -> &mut String

Get the football team’s name mutably

Example

use fbsim_core::team::FootballTeam;

let mut my_team = FootballTeam::new();
let mut name = my_team.name_mut();

pub fn short_name(&self) -> &str

Borrow the football team’s short name / acronym

Example

use fbsim_core::team::FootballTeam;

let my_team = FootballTeam::new();
let short_name = my_team.short_name();

pub fn short_name_mut(&mut self) -> &mut String

Borrow the football team’s short name / acronym mutably

Example

use fbsim_core::team::FootballTeam;

let mut my_team = FootballTeam::new();
let mut short_name = my_team.short_name_mut();

Trait Implementations

impl Clone for FootballTeam

fn clone(&self) -> FootballTeam

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FootballTeam

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

Formats the value using the given formatter.

impl Default for FootballTeam

fn default() -> FootballTeam

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FootballTeam

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Ord for FootballTeam

fn cmp(&self, other: &FootballTeam) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for FootballTeam

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for FootballTeam

fn partial_cmp(&self, other: &FootballTeam) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PlaySimulatable for FootballTeam

fn coach(&self) -> &FootballTeamCoach

Borrow the team’s coach

Example

use fbsim_core::game::play::PlaySimulatable;
use fbsim_core::team::FootballTeam;

let my_team = FootballTeam::new();
let my_coach = my_team.coach();

fn offense(&self) -> &FootballTeamOffense

Borrow the team’s offense

Example

use fbsim_core::game::play::PlaySimulatable;
use fbsim_core::team::FootballTeam;

let my_team = FootballTeam::new();
let my_offense = my_team.offense();

fn defense(&self) -> &FootballTeamDefense

Borrow the team’s defense

Example

use fbsim_core::game::play::PlaySimulatable;
use fbsim_core::team::FootballTeam;

let my_team = FootballTeam::new();
let my_defense = my_team.defense();

impl ScoreSimulatable for FootballTeam

fn name(&self) -> &str

Get the football team’s name

Example

use fbsim_core::team::FootballTeam;

let my_team = FootballTeam::new();
let name = my_team.name();

fn defense_overall(&self) -> u32

Get the overall of the defense

Example

use fbsim_core::game::score::ScoreSimulatable;
use fbsim_core::team::FootballTeam;

let my_team = FootballTeam::from_overalls("My Team", "TEAM", 25, 75).unwrap();
let defense_overall = my_team.defense_overall();
assert!(defense_overall == 75);

fn offense_overall(&self) -> u32

Get the overall of the offense

Example

use fbsim_core::game::score::ScoreSimulatable;
use fbsim_core::team::FootballTeam;

let my_team = FootballTeam::from_overalls("My Team", "TEAM", 25, 75).unwrap();
let offense_overall = my_team.offense_overall();
assert!(offense_overall == 25);

impl Serialize for FootballTeam

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<FootballTeamRaw> for FootballTeam

type Error = String

The type returned in the event of a conversion error.

fn try_from(item: FootballTeamRaw) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for FootballTeam

impl StructuralPartialEq for FootballTeam