Struct VariantOffset

pub struct VariantOffset { /* private fields */ }

Represents an offset that varies depending on the runtime environment.

This struct holds three possible offset values, each corresponding to a different runtime: Special Edition (se_offset), Anniversary Edition (ae_offset), and Virtual Reality (vr_offset).

The appropriate offset is selected based on the current runtime.

Example

use commonlibsse_ng::rel::offset::VariantOffset;
use commonlibsse_ng::rel::ResolvableAddress as _;

let variant_offset = VariantOffset::new(0x1000, 0x2000, 0x3000);
// let offset = variant_offset.offset().unwrap();

Implementations

impl VariantOffset

pub const fn new(se_offset: u64, ae_offset: u64, vr_offset: u64) -> Self

Creates a new VariantOffset instance with specified offsets for each runtime.

Note

Return an error when trying to get the offset and it is 0

Trait Implementations

impl Clone for VariantOffset

fn clone(&self) -> VariantOffset

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VariantOffset

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

Formats the value using the given formatter.

impl Hash for VariantOffset

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 VariantOffset

fn cmp(&self, other: &VariantOffset) -> 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 VariantOffset

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

fn partial_cmp(&self, other: &VariantOffset) -> 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 ResolvableAddress for VariantOffset

fn offset(&self) -> Result<NonZeroUsize, DataBaseError>

Get the offset based on the current runtime.

Errors

• Returns an error if the module state is invalid or the runtime is unknown.
• Returns an error if the offset is 0.

fn address(&self) -> Result<NonNull<c_void>, DataBaseError>

Computes the absolute address by adding the offset to the module’s base address.

fn base() -> Result<NonNull<c_void>, ModuleStateError>

Retrieves the base address of the module.

impl TryFrom<VariantOffset> for Relocation

type Error = DataBaseError

The type returned in the event of a conversion error.

fn try_from(offset: VariantOffset) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for VariantOffset

impl StructuralPartialEq for VariantOffset