Struct RawFactoryPointer 

pub struct RawFactoryPointer<'a, T> { /* private fields */ }

A low-level utility used to implement custom Factory pointer types.

This is a pointer type that allows read-only access to the pointed data, except that it does not deal with references or borrows. You cannot get a reference to the factory structure this points to, only get a copy of the factory structure.

This allows to more easily avoid violating Rust’s strict reference rules. Instead, this type only needs the pointer to adhere to the ptr::read function’s safety rules.

Implementations

impl<'a, T> RawFactoryPointer<'a, T>

pub fn new(inner: &'a T) -> RawFactoryPointer<'a, T>

Creates a new RawFactoryPointer from a shared reference to the factory data structure.

The lifetime of this new pointer is tied to the lifetime of the given reference.

pub const unsafe fn from_raw(raw: NonNull<T>) -> RawFactoryPointer<'a, T>

Creates a new RawFactoryPointer from a non-null pointer to the factory data structure.

Safety

Behavior is undefined if any of the following conditions are violated for the duration of the 'a lifetime:

• raw must be valid for reads;
• raw must be properly aligned (even if T has size 0);
• raw must point to a properly initialized value of type T;
• the memory raw points to must not be written to, it can only be read from.

These requirements are similar to those of the ptr::read function, except this function cannot cause UB if T is not Copy. This is because the only method on this type that actually performs a read, get, checks this statically via a Copy bound.

pub const fn as_raw(&self) -> NonNull<T>

Returns a non-null pointer to the factory structure this pointer points to.

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

Returns a raw pointer to the factory structure this pointer points to.

impl<T> RawFactoryPointer<'_, T>

where T: Copy,

pub fn get(&self) -> T

Reads this pointer to return a copy of the factory structure.

This function is always safe to use.

Trait Implementations

impl<'a, T> Clone for RawFactoryPointer<'a, T>

where T: Clone,

fn clone(&self) -> RawFactoryPointer<'a, T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, T> Copy for RawFactoryPointer<'a, T>

where T: Copy,

impl<T> Debug for RawFactoryPointer<'_, T>

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

Formats the value using the given formatter.

impl<'a, T> Eq for RawFactoryPointer<'a, T>

where T: Eq,

impl<'a, T> Hash for RawFactoryPointer<'a, T>

where T: Hash,

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a, T> PartialEq for RawFactoryPointer<'a, T>

where T: PartialEq,

fn eq(&self, other: &RawFactoryPointer<'a, T>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<T> Send for RawFactoryPointer<'_, T>

where T: Send,

impl<'a, T> StructuralPartialEq for RawFactoryPointer<'a, T>

where T: PartialEq,

impl<T> Sync for RawFactoryPointer<'_, T>

where T: Sync,