Struct ObjectRefHandle

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

Strongly-typed handle to an object.

Use get or as_ref to access the underlying object.

Implementations

impl ObjectRefHandle

pub const fn new() -> Self

Creates a new, null handle.

pub const fn from_handle(handle: BSUntypedPointerHandle) -> Self

Creates a typed handle from an untyped handle.

pub const fn from_raw(value: u32) -> Self

Creates a typed handle from a raw u32 value.

pub const fn as_raw(&self) -> u32

Gets the raw u32 value of the handle.

pub const fn has_value(&self) -> bool

Returns true if the handle is non-zero.

pub const fn reset(&mut self)

Resets the handle to 0.

impl ObjectRefHandle

pub fn get(&self) -> NiPointer<TESObjectREFR>

Retrieves a smart pointer to the underlying object.

pub fn as_ref(&self) -> Option<&TESObjectREFR>

Attempts to get a shared reference to the object.

Trait Implementations

impl Clone for ObjectRefHandle

fn clone(&self) -> ObjectRefHandle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ObjectRefHandle

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

Formats the value using the given formatter.

impl Default for ObjectRefHandle

fn default() -> ObjectRefHandle

Returns the “default value” for a type.

impl From<BSPointerHandle<TESObjectREFR>> for ObjectRefHandle

fn from(inner: BSPointerHandle<TESObjectREFR>) -> Self

Converts to this type from the input type.

impl From<ObjectRefHandle> for BSPointerHandle<TESObjectREFR>

fn from(wrapper: ObjectRefHandle) -> Self

Converts to this type from the input type.

impl PartialEq for ObjectRefHandle

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

impl Zeroable for ObjectRefHandle