Struct GameServer

pub struct GameServer {
    pub name: String,
    pub address: String,
    pub port: u16,
    pub description: String,
    pub location: Option<Country>,
    pub auth_server: String,
    pub query_port: Option<u16>,
    pub channel: Option<String>,
    pub official: bool,
    pub extra: HashMap<String, Field>,
}

Fields

name: String

The name of the server.

address: String

The address through which the server might be accessed on the open internet. This field may be an IPv4 address, IPv6 address, URL, must not contain a port

port: u16

Port of the gameserver address (usually 14004)

description: String

The server description.

location: Option<Country>

The ISO 3166‑1 Alpha-2 code that the server is physically based in (note: this field is intended as an indication of factors like ping, not the language of the server). (e.g. “US”)

auth_server: String

The auth server that must be used to connect to this server. If you want to use the official auth server use Some("https://auth.veloren.net")

query_port: Option<u16>

Port used for server information queries (default: 14006), the address will be the same as the gameserver address. None indicates that the server does not accept information queries.

channel: Option<String>

The version channel used by the server. None means not running a channel distributed by Airshipper. If in doubt, "weekly" is probably correct.

official: bool

Whether the server is officially affiliated with the Veloren project.

extra: HashMap<String, Field>

Any extra attributes provided by the server.

The key is a machine-readable ID. Frontends may choose to display these fields in a different way (for example, adding an icon) based on this machine-readable ID, if they recognise it. There is no specific list of valid IDs and recognition is based on convention. Some examples of IDs include:

• website
• email
• discord
• mastodon
• reddit
• youtube

Implementations

impl GameServer

pub fn new( name: &str, address: &str, port: u16, query_port: Option<u16>, desc: &str, location: Option<Country>, auth: &str, channel: Option<&str>, official: bool, extra: HashMap<String, Field>, ) -> Self

Trait Implementations

impl Clone for GameServer

fn clone(&self) -> GameServer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GameServer

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GameServer

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for GameServer

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for GameServer

impl StructuralPartialEq for GameServer