Struct BSPointerHandle

#[repr(C)]
pub struct BSPointerHandle<T> { /* private fields */ }

A typed handle referencing an object of type T.

This provides type safety for handles, and can be used to retrieve a smart pointer or reference.

Implementations

impl<T> BSPointerHandle<T>

pub const fn new() -> Self

Creates a new, null handle.

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

Creates a handle from an untyped handle.

pub const fn native_handle(&self) -> u32

Returns the raw native handle value.

pub const fn has_value(&self) -> bool

Returns true if the handle has a non-zero value.

pub const fn reset(&mut self)

Resets the handle to 0.

impl<T: RefCountable> BSPointerHandle<T>

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

Retrieves a smart pointer to the underlying object.

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

Attempts to get a shared reference to the underlying object.

Trait Implementations

impl<T> Clone for BSPointerHandle<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for BSPointerHandle<T>

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

Formats the value using the given formatter.

impl<T> Default for BSPointerHandle<T>

fn default() -> Self

Returns the “default value” for a type.

impl From<ActorHandle> for BSPointerHandle<Actor>

fn from(wrapper: ActorHandle) -> Self

Converts to this type from the input type.

impl From<BSPointerHandle<Actor>> for ActorHandle

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

Converts to this type from the input type.

impl From<BSPointerHandle<Projectile>> for ProjectileHandle

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

Converts to this type from the input 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 From<ProjectileHandle> for BSPointerHandle<Projectile>

fn from(wrapper: ProjectileHandle) -> Self

Converts to this type from the input type.

impl<T> PartialEq for BSPointerHandle<T>

fn eq(&self, other: &Self) -> 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<T> Eq for BSPointerHandle<T>