Struct Offset

pub struct Offset(/* private fields */);

Represents an offset that can be used to compute an absolute address.

This struct wraps a usize value, which directly corresponds to an offset.

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

let offset = Offset::new(0x1000);
assert_eq!(offset.offset().unwrap(), core::num::NonZero::new(0x1000).unwrap());

Implementations

impl Offset

pub const fn new(offset: usize) -> Self

Creates a new Offset instance with the given value.

Note

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

Trait Implementations

impl Clone for Offset

fn clone(&self) -> Offset

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Offset

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

Formats the value using the given formatter.

impl Hash for Offset

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 Offset

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

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

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

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

Get the offset.

Errors

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<Offset> for Relocation

type Error = DataBaseError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for Offset

impl Eq for Offset

impl StructuralPartialEq for Offset