Struct Ref 

pub struct Ref<'amx, T: Sized + AmxPrimitive> { /* private fields */ }

Typed pointer to a live cell in the AMX heap/data.

Implements Deref and DerefMut for T, allowing reading and writing the cell directly (*r). The 'amx lifetime ensures the Ref does not outlive its Amx, avoiding dangling pointers.

Implementations

impl<'amx, T: Sized + AmxPrimitive> Ref<'amx, T>

pub unsafe fn new(amx_addr: i32, phys_addr: *mut T) -> Ref<'amx, T>

Creates a Ref from the (AMX address, physical address) pair, already resolved.

Prefer obtaining Ref via Amx::get_ref or via automatic parsing of native arguments — this direct API is the low-level path used internally by the SDK.

Safety

phys_addr must point to a live T cell for as long as this Ref exists and must be aligned for T (debug asserts validate both conditions in builds with debug_assertions).

pub fn address(&self) -> i32

Address of the cell in the AMX address space (not the physical pointer).

This is the value the VM sees — useful when passing the cell back into calls to other AMX functions.

pub fn as_ptr(&self) -> *const T

Physical (host) pointer to the cell.

pub fn as_mut_ptr(&mut self) -> *mut T

Mutable physical pointer to the cell.

Trait Implementations

impl<'amx, T: Sized + AmxPrimitive> AmxCell<'amx> for Ref<'amx, T>

fn from_raw(amx: &'amx Amx, cell: i32) -> AmxResult<Ref<'amx, T>>

Reconstructs the value from a raw AMX cell.

fn as_cell(&self) -> i32

impl<T: Sized + AmxPrimitive> Deref for Ref<'_, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T: Sized + AmxPrimitive> DerefMut for Ref<'_, T>

fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.