Struct StaticRef

pub struct StaticRef<T> { /* private fields */ }

A pointer to statically allocated mutable data such as memory mapped I/O registers.

This is a simple wrapper around a raw pointer that encapsulates an unsafe dereference in a safe manner. It serve the role of creating a &'static T given a raw address and acts similarly to extern definitions, except StaticRef is subject to module and crate boundaries, while extern definitions can be imported anywhere.

Because this defers the actual dereference, this can be put in a const, whereas const I32_REF: &'static i32 = unsafe { &*(0x1000 as *const i32) }; will always fail to compile since 0x1000 doesn’t have an allocation at compile time, even if it’s known to be a valid MMIO address.

Implementations

impl<T> StaticRef<T>

pub const unsafe fn new(ptr: *const T) -> StaticRef<T>

Create a new StaticRef from a raw pointer

Safety

• ptr must be aligned, non-null, and dereferencable as T.
• *ptr must be valid for the program duration.

Trait Implementations

impl<T> Clone for StaticRef<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 StaticRef<T>

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

Formats the value using the given formatter.

impl<T> Deref for StaticRef<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T> Copy for StaticRef<T>