Enum Region

pub enum Region {
    US,
    EU,
    CN,
    KR,
    TW,
    SG,
}

Supported regions for Ribbit endpoints

Regional Availability

Some regions may have network restrictions:

• CN (China): Typically only accessible from within China
• Other regions (US, EU, KR, TW, SG): Generally accessible globally

The client will timeout after 10 seconds if a region is unreachable.

Example

use ribbit_client::Region;

let region = Region::US;
assert_eq!(region.hostname(), "us.version.battle.net");
assert_eq!(region.as_str(), "us");

// Parse from string
let parsed: Region = "eu".parse().unwrap();
assert_eq!(parsed, Region::EU);

Variants

US

United States

EU

Europe

CN

China

KR

Korea

TW

Taiwan

SG

Singapore

Implementations

impl Region

pub fn hostname(&self) -> &'static str

Get the hostname for this region

pub fn as_str(&self) -> &'static str

Get the region code as a string

Trait Implementations

impl Clone for Region

fn clone(&self) -> Region

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Region

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

Formats the value using the given formatter.

impl Display for Region

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

Formats the value using the given formatter.

impl FromStr for Region

type Err = Error

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 Region

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 PartialEq for Region

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

impl Eq for Region

impl StructuralPartialEq for Region