Struct toornament::Tournament

pub struct Tournament {
    pub id: Option<TournamentId>,
    pub discipline: DisciplineId,
    pub name: String,
    pub full_name: Option<String>,
    pub status: TournamentStatus,
    pub date_start: Option<Date>,
    pub date_end: Option<Date>,
    pub time_zone: Option<String>,
    pub online: bool,
    pub public: bool,
    pub location: Option<String>,
    pub country: Option<String>,
    pub size: i64,
    pub participant_type: Option<ParticipantType>,
    pub match_type: Option<MatchType>,
    pub organization: Option<String>,
    pub website: Option<String>,
    pub description: Option<String>,
    pub rules: Option<String>,
    pub prize: Option<String>,
    pub team_size_min: Option<i64>,
    pub team_size_max: Option<i64>,
    pub streams: Option<Streams>,
    pub check_in: Option<bool>,
    pub participant_nationality: Option<bool>,
    pub match_format: Option<MatchFormat>,
}

A tournament object.

Fields

id: Option<TournamentId>

An hexadecimal unique identifier for this tournament. Example: "5608fd12140ba061298b4569"

discipline: DisciplineId

This string is a unique identifier of a discipline. Example: "my_discipline"

name: String

Name of a tournament (maximum 30 characeters). Example: "My Weekly Tournament"

full_name: Option<String>

Complete name of this tournament (maximum 80 characters). Example: "My Weekly Tournament - Long title"

status: TournamentStatus

Status of the tournament. Possible values: setup, running, completed

date_start: Option<Date>

Starting date of the tournament. This value uses the ISO 8601 date containing only the date section. Example: "2015-09-06"

date_end: Option<Date>

Ending date of the tournament. This value uses the ISO 8601 date containing only the date section. Example: "2015-09-07"

time_zone: Option<String>

Time zone of the tournament. This value is represented using the IANA tz database. Example: "America/Sao_Paulo"

online: bool

Whether the tournament is played on internet or not. Example: true

public: bool

Whether the tournament is public or private. Example: true

location: Option<String>

Location (city, address, place of interest) of the tournament. Example: "London"

country: Option<String>

Country of the tournament. This value uses the ISO 3166-1 alpha-2 country code. Example: "UK"

size: i64

Size of a tournament. Represents the expected number of participants it'll be able to manage. Example: 16

participant_type: Option<ParticipantType>

Type of participants who plays in the tournament. Possible values: team, single

match_type: Option<MatchType>

Type of matches played in the tournament. Possible values: duel, ffa

organization: Option<String>

Tournament organizer: individual, group, association or company. Example: "Avery Bullock"

website: Option<String>

URL of the website Example: "http://www.toornament.com"

description: Option<String>

User-defined description of the tournament (maximum 1,500 characters). Example: "My description \n on multiple lines"

rules: Option<String>

User-defined rules of the tournament (maximum 10,000 characters). Example: "My rules \n on multiple lines"

prize: Option<String>

User-defined description of the tournament prizes (maximum 1,500 characters). Example: "1 - 10,000$ \n 2 - 5,000$"

team_size_min: Option<i64>

(Optional) If the "participant type" value in this tournament is 'team', specify the smallest and the largest possible team sizes.

team_size_max: Option<i64>

(Optional) If the "participant type" value in this tournament is 'team', specify the smallest and the largest possible team sizes.

streams: Option<Streams>

(Optional) A list of streams

check_in: Option<bool>

Enable or disable the participant check-in in the tournament. Example: true

participant_nationality: Option<bool>

Enable or disable the participant flag in the tournament. Example: true

match_format: Option<MatchFormat>

Define the default match format for every matches in the tournament. Possible values: none, one, home_away, bo3, bo5, bo7, bo9, bo11

Methods

impl Tournament

pub fn new<S: Into<String>>(
    id: Option<TournamentId>,
    discipline: DisciplineId,
    name: S,
    status: TournamentStatus,
    online: bool,
    public: bool,
    size: i64
) -> Tournament

Creates new Tournament object.

pub fn create<S: Into<String>>(
    discipline: DisciplineId,
    name: S,
    size: i64,
    participant_type: ParticipantType
) -> Tournament

A method which creates Tournament object for creation (Toornament::edit_tournament) purposes.

pub fn id(self, id: Option<TournamentId>) -> Self

A builder method for $field with $field_type type.

pub fn discipline(self, discipline: DisciplineId) -> Self

A builder method for $field with $field_type type.

pub fn name<S: Into<String>>(self, name: S) -> Self

A builder method for $field with String type.

pub fn full_name(self, full_name: Option<String>) -> Self

A builder method for $field with $field_type type.

pub fn status(self, status: TournamentStatus) -> Self

A builder method for $field with $field_type type.

pub fn date_start(self, date_start: Option<Date>) -> Self

A builder method for $field with $field_type type.

pub fn date_end(self, date_end: Option<Date>) -> Self

A builder method for $field with $field_type type.

pub fn time_zone(self, time_zone: Option<String>) -> Self

A builder method for $field with $field_type type.

pub fn online(self, online: bool) -> Self

A builder method for $field with $field_type type.

pub fn public(self, public: bool) -> Self

A builder method for $field with $field_type type.

pub fn location(self, location: Option<String>) -> Self

A builder method for $field with $field_type type.

pub fn country(self, country: Option<String>) -> Self

A builder method for $field with $field_type type.

pub fn size(self, size: i64) -> Self

A builder method for $field with $field_type type.

pub fn participant_type(self, participant_type: Option<ParticipantType>) -> Self

A builder method for $field with $field_type type.

pub fn match_type(self, match_type: Option<MatchType>) -> Self

A builder method for $field with $field_type type.

pub fn organization(self, organization: Option<String>) -> Self

A builder method for $field with $field_type type.

pub fn website(self, website: Option<String>) -> Self

A builder method for $field with $field_type type.

pub fn description(self, description: Option<String>) -> Self

A builder method for $field with $field_type type.

pub fn rules(self, rules: Option<String>) -> Self

A builder method for $field with $field_type type.

pub fn prize(self, prize: Option<String>) -> Self

A builder method for $field with $field_type type.

pub fn team_size_min(self, team_size_min: Option<i64>) -> Self

A builder method for $field with $field_type type.

pub fn team_size_max(self, team_size_max: Option<i64>) -> Self

A builder method for $field with $field_type type.

pub fn streams(self, streams: Option<Streams>) -> Self

A builder method for $field with $field_type type.

pub fn check_in(self, check_in: Option<bool>) -> Self

A builder method for $field with $field_type type.

pub fn participant_nationality(
    self,
    participant_nationality: Option<bool>
) -> Self

A builder method for $field with $field_type type.

pub fn match_format(self, match_format: Option<MatchFormat>) -> Self

A builder method for $field with $field_type type.

impl Tournament

pub fn iter<'a>(&self, client: &'a Toornament) -> Option<TournamentIter<'a>>

Returns iter for the tournament

pub fn into_iter(self, client: &Toornament) -> Option<TournamentIter>

Converts tournament into an iter

Trait Implementations

impl Clone for Tournament

fn clone(&self) -> Tournament

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Tournament

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Tournament

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for Tournament

impl Ord for Tournament

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Tournament> for Tournament

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Tournament> for Tournament

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Tournament

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

Serialize this value into the given Serde serializer.

impl StructuralEq for Tournament

impl StructuralPartialEq for Tournament