Struct veloren_server::settings::server_description::ServerDescriptions

pub struct ServerDescriptions {
    pub default_locale: String,
    pub descriptions: HashMap<String, ServerDescription>,
}

NOTE: Always replace this with the latest server description version. Then update the ServerDescriptionRaw, the TryFrom for ServerDescription, the previously most recent module, and add a new module for the latest version! Please respect the migration upgrade guarantee found in the parent module with any upgrade. Map of all localized ServerDescriptions

Fields

default_locale: String

descriptions: HashMap<String, ServerDescription>

Implementations

impl ServerDescriptions

fn unwrap_locale_or_default<'a, 'b: 'a>( &'b self, locale: Option<&'a str>, ) -> &'a str

pub fn get(&self, locale: Option<&str>) -> Option<&ServerDescription>

pub fn get_rules(&self, locale: Option<&str>) -> Option<&str>

Attempts to get the rules in the specified locale, falls back to default_locale if no rules were specified in this locale

impl ServerDescriptions

pub(super) fn migrate(prev: ServerDescription) -> Self

One-off migration from the previous version. This must be guaranteed to produce a valid settings file as long as it is called with a valid settings file from the previous version.

pub(super) fn validate( &mut self, ) -> Result<Version, <ServerDescriptions as EditableSetting>::Error>

Perform any needed validation on this server description that can’t be done using parsing.

The returned version being “Old” indicates the loaded setting has been modified during validation (this is why validate takes &mut self).

Trait Implementations

impl Clone for ServerDescriptions

fn clone(&self) -> ServerDescriptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for ServerDescriptions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ServerDescriptions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EditableSetting for ServerDescriptions

type Error = Infallible

Please use this error sparingly, since we ideally want to preserve forwards compatibility for all migrations. In particular, this error should be used to fail validation of the original settings file that cannot be caught with ordinary parsing, rather than used to signal errors that occurred during migrations.

type Legacy = ServerDescription

Into is expected to migrate directly to the latest version, which can be implemented using “chaining”. The use of Into here rather than TryInto is intended (together with the expected use of chaining) to prevent migrations from invalidating old save files without warning; there should always be a non-failing migration path from the oldest to latest format (if the migration path fails, we can panic).

type Setting = ServerDescriptionRaw

TryInto<(Version, Self)> is expected to migrate to the latest version from any older version, using “chaining” (see super::banlist for examples).

const FILENAME: &'static str = FILENAME

fn load(data_dir: &Path) -> Self

fn edit<R>( &mut self, data_dir: &Path, f: impl FnOnce(&mut Self) -> Option<R>, ) -> Option<(R, Result<(), Error<Self>>)>

If the result of calling f is None, we return None (this constitutes an early return and lets us abandon the in-progress edit). For example, this can be used to avoid adding a new ban entry if someone is already banned and the user didn’t explicitly specify that they wanted to add a new ban record, even though it would be completely valid to attach one.

fn get_path(data_dir: &Path) -> PathBuf

impl From<ServerDescription> for ServerDescriptions

fn from(value: ServerDescription) -> Self

Legacy migrations can be migrated to the latest version through the process of “chaining” migrations, starting from next::ServerDescription.

Note that legacy files are always valid, which is why we implement From rather than TryFrom.

impl From<ServerDescriptions> for ServerDescriptionRaw

fn from(value: ServerDescriptions) -> Self

Converts to this type from the input type.

impl Serialize for ServerDescriptions

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<ServerDescription> for ServerDescriptions

Pretty much every TryFrom implementation except that of the very last version should look exactly like this.

type Error = <ServerDescriptions as EditableSetting>::Error

The type returned in the event of a conversion error.

fn try_from(value: ServerDescription) -> Result<ServerDescriptions, Self::Error>

Performs the conversion.

impl TryFrom<ServerDescription> for ServerDescriptions

type Error = <ServerDescriptions as EditableSetting>::Error

The type returned in the event of a conversion error.

fn try_from(value: ServerDescription) -> Result<ServerDescriptions, Self::Error>

Performs the conversion.