Struct pui_core::scalar::OpaqueScalar

pub struct OpaqueScalar<S: ScalarAllocator>(_);

A opaque type that allows the implementation of Pool/ PoolMut to be safe

Implementations

impl<S: ScalarAllocator> OpaqueScalar<S>

pub unsafe fn new(scalar: S::Scalar) -> Self

Create a new OpaqueScalar

Safety

• You must have goteen this scalar from OpaqueScalar::into_inner
• You must create at most 1 OpaqueScalar from this scalar

pub fn into_inner(self) -> S::Scalar

Get the underlying scalar from OpaqueScalar

Trait Implementations

impl<A: ScalarAllocator> Eq for OpaqueScalar<A>

impl<A: ScalarAllocator> Hash for OpaqueScalar<A> where
    A::Scalar: Hash, 

pub fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<A: ScalarAllocator> Ord for OpaqueScalar<A> where
    A::Scalar: Ord, 

pub fn cmp(&self, other: &Self) -> 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<A: ScalarAllocator> PartialEq<OpaqueScalar<A>> for OpaqueScalar<A>

pub fn eq(&self, other: &Self) -> bool

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<A: ScalarAllocator> PartialOrd<OpaqueScalar<A>> for OpaqueScalar<A> where
    A::Scalar: PartialOrd, 

pub fn partial_cmp(&self, other: &Self) -> 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.