Struct crossmist::static_ref::StaticRef

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

A &'static T implementing Object.

See the documentation for crossmist::static_ref for a tutorial-grade explanation.

This type can be created via one of the following two ways:

• Safely, via static_ref!
• Unsafely, via StaticRef::new_unchecked

Example

use crossmist::{StaticRef, static_ref};

let num = static_ref!(i32, 123);
assert_eq!(*num, 123);

Implementations

impl<T> StaticRef<T>

pub unsafe fn new_unchecked(reference: &'static T) -> Self

Create StaticRef from a 'static reference.

This is an unsafe function – consider using the safe wrapper static_ref! instead.

Safety

This function is safe to call if:

• The referenced value must have existed since the beginning of the program execution (e.g. the return value of Box::leak won’t work), and
• The referenced value is located outside of a dynamic library.

Example

use crossmist::StaticRef;

static NUM: i32 = 123;
let num = unsafe { StaticRef::new_unchecked(&NUM) };
assert_eq!(*num, 123);

pub fn get(self) -> &'static T

Extract the underlying reference.

StaticRef<T> implements Deref, so this function is only provided for completeness and should seldom be used: instead of static_ref.get().<...> just do static_ref.<...>.

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, fmt: &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: 'static> NonTrivialObject for StaticRef<T>

fn serialize_self_non_trivial(&self, s: &mut Serializer)

Serialize a single object into a serializer.

unsafe fn deserialize_self_non_trivial(d: &mut Deserializer) -> Result<Self>

Deserialize a single object from a deserializer.

impl<T> Copy for StaticRef<T>