Struct Contract 

pub struct Contract {
    pub bid: Bid,
    pub penalty: Penalty,
}

The statement of the pair winning the bidding that they will take at least the number of tricks (in addition to the book of 6 tricks), and the strain denotes the trump suit.

Fields

bid: Bid

The basic part of a contract

penalty: Penalty

The penalty inflicted on the contract

Implementations

impl Contract

pub const fn new(level: u8, strain: Strain, penalty: Penalty) -> Self

Create a contract from a level, strain, and penalty

Panics

When the level is not in 1..=7. In const contexts, this is a compile-time error.

pub const fn contract_points(self) -> i32

Base score for making this contract

https://en.wikipedia.org/wiki/Bridge_scoring#Contract_points

pub const fn score(self, tricks: u8, vulnerable: bool) -> i32

Score for this contract given the number of taken tricks and vulnerability

The vulnerable parameter refers to the declaring side’s vulnerability, not the defenders’.

The score is positive if the declarer makes the contract, and negative if the declarer fails.

Examples

use dds_bridge::{Contract, Penalty, Strain};

// 4♠ making exactly, not vulnerable: 120 (contract) + 300 (game) = 420
let four_spades = Contract::new(4, Strain::Spades, Penalty::Undoubled);
assert_eq!(four_spades.score(10, false), 420);

// 3NT with one overtrick, vulnerable: 100 + 500 (game) + 30 (overtrick) = 630
let three_nt = Contract::new(3, Strain::Notrump, Penalty::Undoubled);
assert_eq!(three_nt.score(10, true), 630);

// 3NT doubled, down one, vulnerable: -200
let three_nt_x = Contract::new(3, Strain::Notrump, Penalty::Doubled);
assert_eq!(three_nt_x.score(8, true), -200);

Trait Implementations

impl Clone for Contract

fn clone(&self) -> Contract

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Contract

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

Formats the value using the given formatter.

impl Display for Contract

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

Formats the value using the given formatter.

impl From<Bid> for Contract

fn from(bid: Bid) -> Self

Converts to this type from the input type.

impl FromStr for Contract

type Err = ParseContractError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Contract

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Contract

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

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

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

impl Eq for Contract

impl StructuralPartialEq for Contract