Struct rivet_matchmaker::model::RegionInfo

#[non_exhaustive]
pub struct RegionInfo {
    pub region_id: Option<String>,
    pub provider_display_name: Option<String>,
    pub region_display_name: Option<String>,
    pub datacenter_coord: Option<Coord>,
    pub datacenter_distance_from_client: Option<Distance>,
}

A region that the player can connect to.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

region_id: Option<String>

A human readable short identifier used to references resources. Different than a rivet.common#Uuid because this is intended to be human readable. Different than rivet.common#DisplayName because this should not include special characters and be short.

provider_display_name: Option<String>

A universally unique identifier.

region_display_name: Option<String>

A universally unique identifier.

datacenter_coord: Option<Coord>

Geographical coordinates for a location on Planet Earth.

datacenter_distance_from_client: Option<Distance>

Distance available in multiple units.

Implementations

impl RegionInfo

pub fn region_id(&self) -> Option<&str>

A human readable short identifier used to references resources. Different than a rivet.common#Uuid because this is intended to be human readable. Different than rivet.common#DisplayName because this should not include special characters and be short.

pub fn provider_display_name(&self) -> Option<&str>

A universally unique identifier.

pub fn region_display_name(&self) -> Option<&str>

A universally unique identifier.

pub fn datacenter_coord(&self) -> Option<&Coord>

Geographical coordinates for a location on Planet Earth.

pub fn datacenter_distance_from_client(&self) -> Option<&Distance>

Distance available in multiple units.

impl RegionInfo

pub fn builder() -> Builder

Creates a new builder-style object to manufacture RegionInfo

Trait Implementations

impl Clone for RegionInfo

fn clone(&self) -> RegionInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RegionInfo

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

Formats the value using the given formatter.

impl PartialEq<RegionInfo> for RegionInfo

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RegionInfo