Enum Runtime

pub enum Runtime {
    Ae = 1,
    Se = 2,
    Vr = 4,
}

Defines Skyrim runtime versions.

Variants

Ae = 1

The Skyrim runtime is a post-Anniversary Edition Skyrim SE release (version 1.6.x and later).

Se = 2

The Skyrim runtime is a pre-Anniversary Edition Skyrim SE release (version 1.5.97 and prior).

Vr = 4

The Skyrim runtime is Skyrim VR.

Implementations

impl Runtime

pub const fn from_version(version: &Version) -> Self

Get the runtime from version.

This function takes a Version object and returns the corresponding Runtime variant.

The runtime is determined based on the version’s minor numbers:

• minor 4 -> Runtime::Vr (Skyrim VR)
• minor 6 -> Runtime::Ae (Skyrim Anniversary Edition)
• Any other version is considered Runtime::Se (Skyrim Special Edition).

If you want strictness, use Runtime::from_version_strict.

Example

use commonlibsse_ng::rel::module::Runtime;
use commonlibsse_ng::rel::version::Version;

let version = Version::new(1, 5, 50, 0); // SE version
let runtime = Runtime::from_version(&version);
assert_eq!(runtime, Runtime::Se);

let version = Version::new(1, 6, 317, 0); // AE version
let runtime = Runtime::from_version(&version);
assert_eq!(runtime, Runtime::Ae);

Laxity of judgment.

This judgment is incorrectly determined to be Vr if the SE is 1.4.2.

This method is useful under the following assumptions

• SE users are using the latest (1.5.97).
• The version update of this library has not caught up with the version of Skyrim, even though the version of Skyrim has been upgraded.

pub const fn from_version_strict(version: &Version) -> Option<Self>

Get the runtime from version, strictly matching predefined database versions.

This function will only return a runtime if the version matches exactly one of the predefined versions in the database.

Example

use commonlibsse_ng::rel::module::Runtime;
use commonlibsse_ng::rel::version::Version;
use commonlibsse_ng::skse::version::{RUNTIME_SSE_1_5_50, RUNTIME_SSE_1_6_317, RUNTIME_VR_1_4_15};

// SE version within range
let runtime = Runtime::from_version_strict(&RUNTIME_SSE_1_5_50);
assert_eq!(runtime, Some(Runtime::Se));

// AE version within range
let runtime = Runtime::from_version_strict(&RUNTIME_SSE_1_6_317);
assert_eq!(runtime, Some(Runtime::Ae));

// VR version
let runtime = Runtime::from_version_strict(&RUNTIME_VR_1_4_15);
assert_eq!(runtime, Some(Runtime::Vr));

pub fn is_ae(&self) -> bool

Is the current Skyrim runtime the Anniversary Edition (AE)?

pub fn is_se(&self) -> bool

Is the current Skyrim runtime the Special Edition (SE).

pub fn is_vr(&self) -> bool

Is the current Skyrim runtime the VR version?

Trait Implementations

impl Clone for Runtime

fn clone(&self) -> Runtime

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Runtime

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

Formats the value using the given formatter.

impl Hash for Runtime

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 Ord for Runtime

fn cmp(&self, other: &Runtime) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Runtime

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

fn partial_cmp(&self, other: &Runtime) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Runtime

impl Eq for Runtime

impl StructuralPartialEq for Runtime