Struct rustoa::Client

pub struct Client { /* fields omitted */ }

The main RusTOA client.

You can use the Client to get the API version and create a Team object.

Implementations

impl Client

pub fn new(api_key: &str) -> Client

Create a new Client object.

Arguments

• api_key - Your Orange Alliance API key as a String.

It returns a Client object.

pub fn api_version(&self) -> String

Get the version of The Orange Alliance API that this crate is using. This method takes no arguments and returns the version as a String.

Panics

This method can panic in three ways:

• The HTTP request to the API fails. This can be because the API is either down or you are being ratelimited.
• Serde cannot properly deserialize the JSON data in the response. This happens because the API has sent invalid JSON.
• The HashMap does not have the needed keys to process the data. This happens because the request was made to the wrong target or the API has sent back an error in JSON form.

pub fn team(&self, team_number: u32) -> Team

This method is used to get an instance of Team.

Arguments

• team_number - The FTC team number as a u32 integer.

It returns a Team object with the necessary data.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.