Struct HolidayAPI

pub struct HolidayAPI { /* private fields */ }

Implementations

impl HolidayAPI

pub fn is_valid_key(key: &str) -> Result<(), HolidayAPIError>

pub fn is_valid_version(version: &i32) -> Result<(), HolidayAPIError>

pub fn new(key: &str) -> Result<HolidayAPI, HolidayAPIError>

Construct a new holiday API

Errors

Will return an Err if the given key is not plausibly a valid one.

Examples

Basic usage

use holidayapi_rust::prelude::*;

let api = HolidayAPI::new("00000000-0000-0000-0000-000000000000").unwrap();

pub fn with_version( key: &str, version: i32, ) -> Result<HolidayAPI, HolidayAPIError>

Construct a new holiday API

Errors

Will return an Err if the given key is not plausibly a valid one. Or the api version is invalid. Current valid versions: [1]

Examples

Basic usage

use holidayapi_rust::prelude::*;

let api = HolidayAPI::with_version("00000000-0000-0000-0000-000000000000", 1).unwrap();

pub async fn custom_request( &self, endpoint: &str, parameters: HashMap<String, String>, ) -> Result<Response, Box<dyn Error>>

Make a custom request.

Examples

Basic usage

use holidayapi_rust::{ HolidayAPI };
use std::collections::HashMap;

let api = HolidayAPI::new("00000000-0000-0000-0000-000000000000").unwrap();
let _future = api.custom_request("countries", HashMap::new());

pub fn countries(&self) -> Request<CountriesResponse>

Generates a minimal countries request and returns it.

Examples

Basic usage

use holidayapi_rust::prelude::*;

let api = HolidayAPI::new("00000000-0000-0000-0000-000000000000").unwrap();
let request = api.countries();

Adding optional parameters with builder pattern

use holidayapi_rust::prelude::*;

let api = HolidayAPI::new("00000000-0000-0000-0000-000000000000").unwrap();
let specific_request = api.countries().search("united states").public();

pub fn holidays(&self, country: &str, year: i32) -> Request<HolidaysResponse>

Generates a minimal holidays request and returns it.

Examples

Basic usage

use holidayapi_rust::prelude::*;

let api = HolidayAPI::new("00000000-0000-0000-0000-000000000000").unwrap();
let request = api.holidays("us", 2020);

Adding optional parameters with builder pattern

use holidayapi_rust::prelude::*;

let api = HolidayAPI::new("00000000-0000-0000-0000-000000000000").unwrap();
let specific_request = api.holidays("us", 2020).month(12).upcoming();

pub fn workday( &self, country: &str, start: &str, days: i32, ) -> Request<WorkdayResponse>

Generates a minimal workday request and returns it.

Examples

Basic usage

use holidayapi_rust::prelude::*;

let api = HolidayAPI::new("00000000-0000-0000-0000-000000000000").unwrap();
let request = api.workday("us","YYYY-MM-DD", 100);

pub fn workdays( &self, country: &str, start: &str, days: &str, ) -> Request<WorkdaysResponse>

Generates a minimal workdays request and returns it.

Examples

Basic usage

use holidayapi_rust::prelude::*;

let api = HolidayAPI::new("00000000-0000-0000-0000-000000000000").unwrap();
let request = api.workdays("us", "YYYY-MM-DD", "YYYY-MM-DD");

pub fn languages(&self) -> Request<LanguagesResponse>

Generates a minimal languages request and returns it.

Examples

Basic usage

use holidayapi_rust::prelude::*;

let api = HolidayAPI::new("00000000-0000-0000-0000-000000000000").unwrap();
let request = api.languages();

Adding optional parameters with builder pattern

use holidayapi_rust::prelude::*;

let api = HolidayAPI::new("00000000-0000-0000-0000-000000000000").unwrap();
let specific_request = api.languages().search("united states");

Trait Implementations

impl Clone for HolidayAPI

fn clone(&self) -> HolidayAPI

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HolidayAPI

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

Formats the value using the given formatter.