Enum ClinchKind 

#[repr(u8)]
pub enum ClinchKind {
    Bye = 4,
    Divisional = 3,
    WildCard = 2,
    Postseason = 1,
    None = 0,
}

Different indicators for clinching the playoffs.

Note: This assumes the modern postseason format, if you are dealing with older formats the predicates below are not guaranteed to work.

Variants

Bye = 4

The Team has clinched a top seed guaranteeing a bye.

Divisional = 3

The team has clinched their position in the division.

WildCard = 2

The team has clinched a wild card position.

Postseason = 1

The team has clinched a position in the postseason, however that specific placement is unknown.

None = 0

Team has not clinched the postseason.

Implementations

impl ClinchKind

pub const fn clinched_postseason(self) -> bool

Whether a team is guaranteed to play in the postseason.

Examples

use mlb_api::standings::ClinchKind;

assert!(  ClinchKind::Bye.clinched_postseason());
assert!(  ClinchKind::WildCard.clinched_postseason());
assert!(  ClinchKind::Postseason.clinched_postseason());
assert!(! ClinchKind::None.clinched_postseason());

pub const fn is_final(self) -> bool

Whether the ClinchKind is a final decision and cannot be changed.

Examples

use mlb_api::standings::ClinchKind;

assert!(  ClinchKind::Bye.is_final());
assert!(  ClinchKind::WildCard.is_final());
assert!(! ClinchKind::Postseason.is_final());
assert!(! ClinchKind::None.is_final());

pub const fn guaranteed_in_wildcard(self) -> bool

Whether the team will play in a Wild Card Series.

If the postseason decision is not final, the team is considered to not play in the wild card round. If you want different behavior use Self::guaranteed_in_wildcard.

Examples

use mlb_api::standings::ClinchKind;

assert!(! ClinchKind::Bye.guaranteed_in_wildcard());
assert!(  ClinchKind::Divisional.guaranteed_in_wildcard());
assert!(  ClinchKind::WildCard.guaranteed_in_wildcard());
assert!(! ClinchKind::None.guaranteed_in_wildcard());
assert!(! ClinchKind::Postseason.guaranteed_in_wildcard());

pub const fn potentially_in_wildcard(self) -> bool

Whether the team has a possibility of playing in the Wild Card Series.

Examples

use mlb_api::standings::ClinchKind;

assert!(! ClinchKind::Bye.guaranteed_in_wildcard());
assert!(  ClinchKind::Divisional.guaranteed_in_wildcard());
assert!(  ClinchKind::WildCard.guaranteed_in_wildcard());
assert!(  ClinchKind::None.guaranteed_in_wildcard());
assert!(  ClinchKind::Postseason.guaranteed_in_wildcard());

Trait Implementations

impl Clone for ClinchKind

fn clone(&self) -> ClinchKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClinchKind

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

Formats the value using the given formatter.

impl Default for ClinchKind

fn default() -> ClinchKind

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ClinchKind

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Ord for ClinchKind

fn cmp(&self, other: &ClinchKind) -> 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 ClinchKind

fn eq(&self, other: &ClinchKind) -> 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 ClinchKind

fn partial_cmp(&self, other: &ClinchKind) -> 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 Copy for ClinchKind

impl Eq for ClinchKind

impl StructuralPartialEq for ClinchKind