Struct emf_core_base_rs_ffi::collections::NonNullConst

#[repr(transparent)]
pub struct NonNullConst<T> where
    T: ?Sized,  { /* fields omitted */ }

A type representing a *const T but non-zero.

Uses NonNull internally, as such, the same restrictions apply.

Implementations

impl<T> NonNullConst<T>

pub const fn dangling() -> NonNullConst<T>

Creates a new NonNullConst that is dangling, but well-aligned.

impl<T> NonNullConst<T> where
    T: ?Sized, 

pub const unsafe fn new_unchecked(ptr: *const T) -> NonNullConst<T>

Creates a new NonNull.

Safety

The same restrictions as NonNull::new_unchecked apply.

pub fn new(ptr: *const T) -> Option<NonNullConst<T>>

Creates a new NonNullConst if ptr is non-null.

pub unsafe fn into_mut(&self) -> NonNull<T>

Acquires a mutable version of the pointer.

Safety

It is undefined behavior if the underlying pointer is not already mutable.

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

Acquires the underlying *const pointer.

pub unsafe fn as_ref(&self) -> &T

Returns a shared reference to the value.

Safety

The same restrictions as NonNull::as_ref apply.

pub const fn cast<U>(self) -> NonNullConst<U>

Casts to a pointer of another type.

Trait Implementations

impl<T> Clone for NonNullConst<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Copy for NonNullConst<T>

impl<T> Debug for NonNullConst<T> where
    T: Debug + ?Sized, 

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

Formats the value using the given formatter.

impl<T> Eq for NonNullConst<T> where
    T: Eq + ?Sized, 

impl<T, const N: usize> From<&'_ [T; N]> for NonNullConst<T> where
    T: Sized, 

fn from(array: &[T; N]) -> Self

Performs the conversion.

impl<T> From<&'_ [T]> for NonNullConst<T> where
    T: Sized, 

fn from(slice: &[T]) -> Self

Performs the conversion.

impl<T> From<&'_ T> for NonNullConst<T> where
    T: ?Sized, 

fn from(value: &T) -> Self

Performs the conversion.

impl<T, const N: usize> From<&'_ mut [T; N]> for NonNullConst<T> where
    T: Sized, 

fn from(array: &mut [T; N]) -> Self

Performs the conversion.

impl<T> From<&'_ mut [T]> for NonNullConst<T> where
    T: Sized, 

fn from(slice: &mut [T]) -> Self

Performs the conversion.

impl<T> From<&'_ mut T> for NonNullConst<T> where
    T: ?Sized, 

fn from(value: &mut T) -> Self

Performs the conversion.

impl<T> From<NonNull<T>> for NonNullConst<T> where
    T: ?Sized, 

fn from(ptr: NonNull<T>) -> Self

Performs the conversion.

impl<T> Ord for NonNullConst<T> where
    T: Ord + ?Sized, 

fn cmp(&self, other: &NonNullConst<T>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<T> PartialEq<NonNullConst<T>> for NonNullConst<T> where
    T: PartialEq + ?Sized, 

fn eq(&self, other: &NonNullConst<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &NonNullConst<T>) -> bool

This method tests for !=.

impl<T> PartialOrd<NonNullConst<T>> for NonNullConst<T> where
    T: PartialOrd + ?Sized, 

fn partial_cmp(&self, other: &NonNullConst<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> StructuralEq for NonNullConst<T> where
    T: ?Sized, 

impl<T> StructuralPartialEq for NonNullConst<T> where
    T: ?Sized,