devela::num

Struct Compare

Source 
#[repr(transparent)]
pub struct Compare<T>(pub T);
Expand description

Provides comparing methods for T.

It provides the non-const methods pclamp, pmax, pmin for comparing PartialOrdered values.

It provides the following const methods for comparing primitives: clamp, max, min, eq, ne, lt, le, gt, ge.

In the case of floating-point primitives:

  • total ordering is used.
  • aditional methods are provided: is_positive, is_negative, is_finite, is_infinite, is_nan.

Tuple Fields§

§0: T

Implementations§

Source§

impl<T: PartialOrd> Compare<T>

Source

pub fn pclamp(self, min: T, max: T) -> Option<T> ⓘ

Compares and returns a PartialOrdered value clamped between min and max.

Returns None if comparisons are indeterminate.

§Examples
assert_eq![Some(0.4), Compare(1.0).pclamp(0.2, 0.4)];
assert_eq![Some(0.2), Compare(0.0).pclamp(0.2, 0.4)];
//
assert_eq![None, Compare(1.0).pclamp(f32::NAN, f32::NAN)];
assert_eq![None, Compare(1.0).pclamp(f32::NAN, 0.4)];
assert_eq![None, Compare(1.0).pclamp(0.2, f32::NAN)];
Source

pub fn pmax(self, other: T) -> Option<T> ⓘ

Compares and returns the maximum of two PartialOrdered values.

Returns None if comparisons are indeterminate.

Complements core::cmp::max which requires Ord

§Examples
assert_eq![Some(0.4), Compare(0.2).pmax(0.4)];
//
assert_eq![None, Compare(0.2).pmax(f32::NAN)];
assert_eq![None, Compare(f32::NAN).pmax(0.4)];
Source

pub fn pmin(self, other: T) -> Option<T> ⓘ

Compares and returns the minimum of two PartialOrdered values.

Returns None if comparisons are indeterminate.

Complements core::cmp::min which requires Ord

§Example
assert_eq![Some(0.2), Compare(0.2).pmin(0.4)];
//
assert_eq![None, Compare(0.2).pmin(f32::NAN)];
assert_eq![None, Compare(f32::NAN).pmin(0.4)];
Source§

impl Compare<u8>

Source

pub const fn clamp(self, min: u8, max: u8) -> u8 ⓘ

Compares and returns self clamped between min and max.

Source

pub const fn max(self, other: u8) -> u8 ⓘ

Compares and returns the maximum between self and other.

Source

pub const fn min(self, other: u8) -> u8 ⓘ

Compares and returns the minimum between self and other.

Source

pub const fn eq(self, other: u8) -> bool

Returns true if self == other.

Source

pub const fn ne(self, other: u8) -> bool

Returns true if self != other.

Source

pub const fn lt(self, other: u8) -> bool

Returns true if self < other.

Source

pub const fn le(self, other: u8) -> bool

Returns true if self <= other.

Source

pub const fn gt(self, other: u8) -> bool

Returns true if self > other.

Source

pub const fn ge(self, other: u8) -> bool

Returns true if self >= other.

Source§

impl Compare<u16>

Source

pub const fn clamp(self, min: u16, max: u16) -> u16 ⓘ

Compares and returns self clamped between min and max.

Source

pub const fn max(self, other: u16) -> u16 ⓘ

Compares and returns the maximum between self and other.

Source

pub const fn min(self, other: u16) -> u16 ⓘ

Compares and returns the minimum between self and other.

Source

pub const fn eq(self, other: u16) -> bool

Returns true if self == other.

Source

pub const fn ne(self, other: u16) -> bool

Returns true if self != other.

Source

pub const fn lt(self, other: u16) -> bool

Returns true if self < other.

Source

pub const fn le(self, other: u16) -> bool

Returns true if self <= other.

Source

pub const fn gt(self, other: u16) -> bool

Returns true if self > other.

Source

pub const fn ge(self, other: u16) -> bool

Returns true if self >= other.

Source§

impl Compare<u32>

Source

pub const fn clamp(self, min: u32, max: u32) -> u32 ⓘ

Compares and returns self clamped between min and max.

Source

pub const fn max(self, other: u32) -> u32 ⓘ

Compares and returns the maximum between self and other.

Source

pub const fn min(self, other: u32) -> u32 ⓘ

Compares and returns the minimum between self and other.

Source

pub const fn eq(self, other: u32) -> bool

Returns true if self == other.

Source

pub const fn ne(self, other: u32) -> bool

Returns true if self != other.

Source

pub const fn lt(self, other: u32) -> bool

Returns true if self < other.

Source

pub const fn le(self, other: u32) -> bool

Returns true if self <= other.

Source

pub const fn gt(self, other: u32) -> bool

Returns true if self > other.

Source

pub const fn ge(self, other: u32) -> bool

Returns true if self >= other.

Source§

impl Compare<u64>

Source

pub const fn clamp(self, min: u64, max: u64) -> u64 ⓘ

Compares and returns self clamped between min and max.

Source

pub const fn max(self, other: u64) -> u64 ⓘ

Compares and returns the maximum between self and other.

Source

pub const fn min(self, other: u64) -> u64 ⓘ

Compares and returns the minimum between self and other.

Source

pub const fn eq(self, other: u64) -> bool

Returns true if self == other.

Source

pub const fn ne(self, other: u64) -> bool

Returns true if self != other.

Source

pub const fn lt(self, other: u64) -> bool

Returns true if self < other.

Source

pub const fn le(self, other: u64) -> bool

Returns true if self <= other.

Source

pub const fn gt(self, other: u64) -> bool

Returns true if self > other.

Source

pub const fn ge(self, other: u64) -> bool

Returns true if self >= other.

Source§

impl Compare<u128>

Source

pub const fn clamp(self, min: u128, max: u128) -> u128 ⓘ

Compares and returns self clamped between min and max.

Source

pub const fn max(self, other: u128) -> u128 ⓘ

Compares and returns the maximum between self and other.

Source

pub const fn min(self, other: u128) -> u128 ⓘ

Compares and returns the minimum between self and other.

Source

pub const fn eq(self, other: u128) -> bool

Returns true if self == other.

Source

pub const fn ne(self, other: u128) -> bool

Returns true if self != other.

Source

pub const fn lt(self, other: u128) -> bool

Returns true if self < other.

Source

pub const fn le(self, other: u128) -> bool

Returns true if self <= other.

Source

pub const fn gt(self, other: u128) -> bool

Returns true if self > other.

Source

pub const fn ge(self, other: u128) -> bool

Returns true if self >= other.

Source§

impl Compare<usize>

Source

pub const fn clamp(self, min: usize, max: usize) -> usize ⓘ

Compares and returns self clamped between min and max.

Source

pub const fn max(self, other: usize) -> usize ⓘ

Compares and returns the maximum between self and other.

Source

pub const fn min(self, other: usize) -> usize ⓘ

Compares and returns the minimum between self and other.

Source

pub const fn eq(self, other: usize) -> bool

Returns true if self == other.

Source

pub const fn ne(self, other: usize) -> bool

Returns true if self != other.

Source

pub const fn lt(self, other: usize) -> bool

Returns true if self < other.

Source

pub const fn le(self, other: usize) -> bool

Returns true if self <= other.

Source

pub const fn gt(self, other: usize) -> bool

Returns true if self > other.

Source

pub const fn ge(self, other: usize) -> bool

Returns true if self >= other.

Source§

impl Compare<i8>

Source

pub const fn clamp(self, min: i8, max: i8) -> i8 ⓘ

Compares and returns self clamped between min and max.

Source

pub const fn max(self, other: i8) -> i8 ⓘ

Compares and returns the maximum between self and other.

Source

pub const fn min(self, other: i8) -> i8 ⓘ

Compares and returns the minimum between self and other.

Source

pub const fn eq(self, other: i8) -> bool

Returns true if self == other.

Source

pub const fn ne(self, other: i8) -> bool

Returns true if self != other.

Source

pub const fn lt(self, other: i8) -> bool

Returns true if self < other.

Source

pub const fn le(self, other: i8) -> bool

Returns true if self <= other.

Source

pub const fn gt(self, other: i8) -> bool

Returns true if self > other.

Source

pub const fn ge(self, other: i8) -> bool

Returns true if self >= other.

Source§

impl Compare<i16>

Source

pub const fn clamp(self, min: i16, max: i16) -> i16 ⓘ

Compares and returns self clamped between min and max.

Source

pub const fn max(self, other: i16) -> i16 ⓘ

Compares and returns the maximum between self and other.

Source

pub const fn min(self, other: i16) -> i16 ⓘ

Compares and returns the minimum between self and other.

Source

pub const fn eq(self, other: i16) -> bool

Returns true if self == other.

Source

pub const fn ne(self, other: i16) -> bool

Returns true if self != other.

Source

pub const fn lt(self, other: i16) -> bool

Returns true if self < other.

Source

pub const fn le(self, other: i16) -> bool

Returns true if self <= other.

Source

pub const fn gt(self, other: i16) -> bool

Returns true if self > other.

Source

pub const fn ge(self, other: i16) -> bool

Returns true if self >= other.

Source§

impl Compare<i32>

Source

pub const fn clamp(self, min: i32, max: i32) -> i32 ⓘ

Compares and returns self clamped between min and max.

Source

pub const fn max(self, other: i32) -> i32 ⓘ

Compares and returns the maximum between self and other.

Source

pub const fn min(self, other: i32) -> i32 ⓘ

Compares and returns the minimum between self and other.

Source

pub const fn eq(self, other: i32) -> bool

Returns true if self == other.

Source

pub const fn ne(self, other: i32) -> bool

Returns true if self != other.

Source

pub const fn lt(self, other: i32) -> bool

Returns true if self < other.

Source

pub const fn le(self, other: i32) -> bool

Returns true if self <= other.

Source

pub const fn gt(self, other: i32) -> bool

Returns true if self > other.

Source

pub const fn ge(self, other: i32) -> bool

Returns true if self >= other.

Source§

impl Compare<i64>

Source

pub const fn clamp(self, min: i64, max: i64) -> i64 ⓘ

Compares and returns self clamped between min and max.

Source

pub const fn max(self, other: i64) -> i64 ⓘ

Compares and returns the maximum between self and other.

Source

pub const fn min(self, other: i64) -> i64 ⓘ

Compares and returns the minimum between self and other.

Source

pub const fn eq(self, other: i64) -> bool

Returns true if self == other.

Source

pub const fn ne(self, other: i64) -> bool

Returns true if self != other.

Source

pub const fn lt(self, other: i64) -> bool

Returns true if self < other.

Source

pub const fn le(self, other: i64) -> bool

Returns true if self <= other.

Source

pub const fn gt(self, other: i64) -> bool

Returns true if self > other.

Source

pub const fn ge(self, other: i64) -> bool

Returns true if self >= other.

Source§

impl Compare<i128>

Source

pub const fn clamp(self, min: i128, max: i128) -> i128 ⓘ

Compares and returns self clamped between min and max.

Source

pub const fn max(self, other: i128) -> i128 ⓘ

Compares and returns the maximum between self and other.

Source

pub const fn min(self, other: i128) -> i128 ⓘ

Compares and returns the minimum between self and other.

Source

pub const fn eq(self, other: i128) -> bool

Returns true if self == other.

Source

pub const fn ne(self, other: i128) -> bool

Returns true if self != other.

Source

pub const fn lt(self, other: i128) -> bool

Returns true if self < other.

Source

pub const fn le(self, other: i128) -> bool

Returns true if self <= other.

Source

pub const fn gt(self, other: i128) -> bool

Returns true if self > other.

Source

pub const fn ge(self, other: i128) -> bool

Returns true if self >= other.

Source§

impl Compare<isize>

Source

pub const fn clamp(self, min: isize, max: isize) -> isize ⓘ

Compares and returns self clamped between min and max.

Source

pub const fn max(self, other: isize) -> isize ⓘ

Compares and returns the maximum between self and other.

Source

pub const fn min(self, other: isize) -> isize ⓘ

Compares and returns the minimum between self and other.

Source

pub const fn eq(self, other: isize) -> bool

Returns true if self == other.

Source

pub const fn ne(self, other: isize) -> bool

Returns true if self != other.

Source

pub const fn lt(self, other: isize) -> bool

Returns true if self < other.

Source

pub const fn le(self, other: isize) -> bool

Returns true if self <= other.

Source

pub const fn gt(self, other: isize) -> bool

Returns true if self > other.

Source

pub const fn ge(self, other: isize) -> bool

Returns true if self >= other.

Source§

impl Compare<f32>

Source

pub const fn total_cmp(self, other: f32) -> Ordering

A (const) port of f32::total_cmp.

Source

pub const fn clamp(self, min: f32, max: f32) -> f32 ⓘ

Compares and returns a clamped total ordered self between min and max.

§Examples
assert_eq![2.0, Compare(5.0f32).clamp(-1.0, 2.0)];
assert_eq![-1.0, Compare(-5.0f32).clamp(-1.0, 2.0)];
Source

pub const fn max(self, other: f32) -> f32 ⓘ

Compares and returns the total ordered maximum between self and other.

§Examples
assert_eq![2.0, Compare(2.0f32).max(-1.0)];
assert_eq![2.0, Compare(1.0f32).max(2.0)];
assert_eq![0.0, Compare(-0.0f32).max(0.0)];
assert_eq![f32::INFINITY, Compare(f32::INFINITY).max(f32::NEG_INFINITY)];
Source

pub const fn min(self, other: f32) -> f32 ⓘ

Compares and returns the total ordered minimum between self and other.

§Examples
assert_eq![-1.0, Compare(2.0f32).min(-1.0)];
assert_eq![1.0, Compare(1.0f32).min(2.0)];
assert_eq![-0.0, Compare(-0.0f32).min(0.0)];
assert_eq![f32::NEG_INFINITY, Compare(f32::INFINITY).min(f32::NEG_INFINITY)];
Source

pub const fn eq(self, other: f32) -> bool

Returns true if self == other using total order.

Source

pub const fn ne(self, other: f32) -> bool

Returns true if self != other using total order.

Source

pub const fn lt(self, other: f32) -> bool

Returns true if self < other using total order.

Source

pub const fn le(self, other: f32) -> bool

Returns true if self <= other using total order.

Source

pub const fn gt(self, other: f32) -> bool

Returns true if self > other using total order.

Source

pub const fn ge(self, other: f32) -> bool

Returns true if self >= other using total order.

Source

pub const fn is_positive(self) -> bool

Returns true if self is sign positive.

Source

pub const fn is_negative(self) -> bool

Returns true if self is sign negative.

Source

pub const fn is_infinite(self) -> bool

Returns true if self is infinite (either negative or positive).

Source

pub const fn is_finite(self) -> bool

Returns true if self is nether infinite nor NaN.

Source

pub const fn is_nan(self) -> bool

Returns true if self is NaN.

Source

pub const fn is_subnormal(self) -> bool

Returns true if self is subnormal.

Source

pub const fn is_normal(self) -> bool

Returns true if self is neither zero, infinite, subnormal, or NaN.

Source§

impl Compare<f64>

Source

pub const fn total_cmp(self, other: f64) -> Ordering

A (const) port of f64::total_cmp.

Source

pub const fn clamp(self, min: f64, max: f64) -> f64 ⓘ

Compares and returns a clamped total ordered self between min and max.

§Examples
assert_eq![2.0, Compare(5.0f64).clamp(-1.0, 2.0)];
assert_eq![-1.0, Compare(-5.0f64).clamp(-1.0, 2.0)];
Source

pub const fn max(self, other: f64) -> f64 ⓘ

Compares and returns the total ordered maximum between self and other.

§Examples
assert_eq![2.0, Compare(2.0f64).max(-1.0)];
assert_eq![2.0, Compare(1.0f64).max(2.0)];
assert_eq![0.0, Compare(-0.0f64).max(0.0)];
assert_eq![f64::INFINITY, Compare(f64::INFINITY).max(f64::NEG_INFINITY)];
Source

pub const fn min(self, other: f64) -> f64 ⓘ

Compares and returns the total ordered minimum between self and other.

§Examples
assert_eq![-1.0, Compare(2.0f64).min(-1.0)];
assert_eq![1.0, Compare(1.0f64).min(2.0)];
assert_eq![-0.0, Compare(-0.0f64).min(0.0)];
assert_eq![f64::NEG_INFINITY, Compare(f64::INFINITY).min(f64::NEG_INFINITY)];
Source

pub const fn eq(self, other: f64) -> bool

Returns true if self == other using total order.

Source

pub const fn ne(self, other: f64) -> bool

Returns true if self != other using total order.

Source

pub const fn lt(self, other: f64) -> bool

Returns true if self < other using total order.

Source

pub const fn le(self, other: f64) -> bool

Returns true if self <= other using total order.

Source

pub const fn gt(self, other: f64) -> bool

Returns true if self > other using total order.

Source

pub const fn ge(self, other: f64) -> bool

Returns true if self >= other using total order.

Source

pub const fn is_positive(self) -> bool

Returns true if self is sign positive.

Source

pub const fn is_negative(self) -> bool

Returns true if self is sign negative.

Source

pub const fn is_infinite(self) -> bool

Returns true if self is infinite (either negative or positive).

Source

pub const fn is_finite(self) -> bool

Returns true if self is nether infinite nor NaN.

Source

pub const fn is_nan(self) -> bool

Returns true if self is NaN.

Source

pub const fn is_subnormal(self) -> bool

Returns true if self is subnormal.

Source

pub const fn is_normal(self) -> bool

Returns true if self is neither zero, infinite, subnormal, or NaN.

Source§

impl Compare<f16>

Source

pub const fn total_cmp(self, other: f16) -> Ordering

A (const) port of f16::[total_cmp][f16#method.total_cmp].

Source

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

Compares and returns a clamped total ordered self between min and max.

§Examples
assert_eq![2.0, Compare(5.0f16).clamp(-1.0, 2.0)];
assert_eq![-1.0, Compare(-5.0f16).clamp(-1.0, 2.0)];
Source

pub const fn max(self, other: f16) -> f16

Compares and returns the total ordered maximum between self and other.

§Examples
assert_eq![2.0, Compare(2.0f16).max(-1.0)];
assert_eq![2.0, Compare(1.0f16).max(2.0)];
assert_eq![0.0, Compare(-0.0f16).max(0.0)];
assert_eq![f16::INFINITY, Compare(f16::INFINITY).max(f16::NEG_INFINITY)];
Source

pub const fn min(self, other: f16) -> f16

Compares and returns the total ordered minimum between self and other.

§Examples
assert_eq![-1.0, Compare(2.0f16).min(-1.0)];
assert_eq![1.0, Compare(1.0f16).min(2.0)];
assert_eq![-0.0, Compare(-0.0f16).min(0.0)];
assert_eq![f16::NEG_INFINITY, Compare(f16::INFINITY).min(f16::NEG_INFINITY)];
Source

pub const fn eq(self, other: f16) -> bool

Returns true if self == other using total order.

Source

pub const fn ne(self, other: f16) -> bool

Returns true if self != other using total order.

Source

pub const fn lt(self, other: f16) -> bool

Returns true if self < other using total order.

Source

pub const fn le(self, other: f16) -> bool

Returns true if self <= other using total order.

Source

pub const fn gt(self, other: f16) -> bool

Returns true if self > other using total order.

Source

pub const fn ge(self, other: f16) -> bool

Returns true if self >= other using total order.

Source

pub const fn is_positive(self) -> bool

Returns true if self is sign positive.

Source

pub const fn is_negative(self) -> bool

Returns true if self is sign negative.

Source

pub const fn is_infinite(self) -> bool

Returns true if self is infinite (either negative or positive).

Source

pub const fn is_finite(self) -> bool

Returns true if self is nether infinite nor NaN.

Source

pub const fn is_nan(self) -> bool

Returns true if self is NaN.

Source

pub const fn is_subnormal(self) -> bool

Returns true if self is subnormal.

Source

pub const fn is_normal(self) -> bool

Returns true if self is neither zero, infinite, subnormal, or NaN.

Source§

impl Compare<f128>

Source

pub const fn total_cmp(self, other: f128) -> Ordering

A (const) port of f128::[total_cmp][f128#method.total_cmp].

Source

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

Compares and returns a clamped total ordered self between min and max.

§Examples
assert_eq![2.0, Compare(5.0f128).clamp(-1.0, 2.0)];
assert_eq![-1.0, Compare(-5.0f128).clamp(-1.0, 2.0)];
Source

pub const fn max(self, other: f128) -> f128

Compares and returns the total ordered maximum between self and other.

§Examples
assert_eq![2.0, Compare(2.0f128).max(-1.0)];
assert_eq![2.0, Compare(1.0f128).max(2.0)];
assert_eq![0.0, Compare(-0.0f128).max(0.0)];
assert_eq![f128::INFINITY, Compare(f128::INFINITY).max(f128::NEG_INFINITY)];
Source

pub const fn min(self, other: f128) -> f128

Compares and returns the total ordered minimum between self and other.

§Examples
assert_eq![-1.0, Compare(2.0f128).min(-1.0)];
assert_eq![1.0, Compare(1.0f128).min(2.0)];
assert_eq![-0.0, Compare(-0.0f128).min(0.0)];
assert_eq![f128::NEG_INFINITY, Compare(f128::INFINITY).min(f128::NEG_INFINITY)];
Source

pub const fn eq(self, other: f128) -> bool

Returns true if self == other using total order.

Source

pub const fn ne(self, other: f128) -> bool

Returns true if self != other using total order.

Source

pub const fn lt(self, other: f128) -> bool

Returns true if self < other using total order.

Source

pub const fn le(self, other: f128) -> bool

Returns true if self <= other using total order.

Source

pub const fn gt(self, other: f128) -> bool

Returns true if self > other using total order.

Source

pub const fn ge(self, other: f128) -> bool

Returns true if self >= other using total order.

Source

pub const fn is_positive(self) -> bool

Returns true if self is sign positive.

Source

pub const fn is_negative(self) -> bool

Returns true if self is sign negative.

Source

pub const fn is_infinite(self) -> bool

Returns true if self is infinite (either negative or positive).

Source

pub const fn is_finite(self) -> bool

Returns true if self is nether infinite nor NaN.

Source

pub const fn is_nan(self) -> bool

Returns true if self is NaN.

Source

pub const fn is_subnormal(self) -> bool

Returns true if self is subnormal.

Source

pub const fn is_normal(self) -> bool

Returns true if self is neither zero, infinite, subnormal, or NaN.

Trait Implementations§

Source§

impl<T: Clone> Clone for Compare<T>

Source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for Compare<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: Display> Display for Compare<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: Ord> Ord for Compare<T>

Source§

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl<T: PartialEq> PartialEq for Compare<T>

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<T: PartialOrd> PartialOrd for Compare<T>

Source§

fn partial_cmp(&self, other: &Self) -> Option<Ordering> ⓘ

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<T: Copy> Copy for Compare<T>

Source§

impl<T: Eq> Eq for Compare<T>

Auto Trait Implementations§

§

impl<T> Freeze for Compare<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Compare<T>
where T: RefUnwindSafe,

§

impl<T> Send for Compare<T>
where T: Send,

§

impl<T> Sync for Compare<T>
where T: Sync,

§

impl<T> Unpin for Compare<T>
where T: Unpin,

§

impl<T> UnwindSafe for Compare<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> ArchivePointee for T

§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> ByteSized for T

Source§

const BYTE_ALIGN: usize = _

The alignment of this type in bytes.
Source§

const BYTE_SIZE: usize = _

The size of this type in bytes.
Source§

fn byte_align(&self) -> usize ⓘ

Returns the alignment of this type in bytes.
Source§

fn byte_size(&self) -> usize ⓘ

Returns the size of this type in bytes. Read more
Source§

fn ptr_size_ratio(&self) -> [usize; 2]

Returns the size ratio between Ptr::BYTES and BYTE_SIZE. Read more
Source§

impl<T, R> Chain<R> for T
where T: ?Sized,

Source§

fn chain<F>(self, f: F) -> R
where F: FnOnce(Self) -> R, Self: Sized,

Chain a function which takes the parameter by value.
Source§

fn chain_ref<F>(&self, f: F) -> R
where F: FnOnce(&Self) -> R,

Chain a function which takes the parameter by shared reference.
Source§

fn chain_mut<F>(&mut self, f: F) -> R
where F: FnOnce(&mut Self) -> R,

Chain a function which takes the parameter by exclusive reference.
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> ExtAny for T
where T: Any + ?Sized,

Source§

fn type_id() -> TypeId

Returns the TypeId of Self. Read more
Source§

fn type_of(&self) -> TypeId

Returns the TypeId of self. Read more
Source§

fn type_name(&self) -> &'static str ⓘ

Returns the type name of self. Read more
Source§

fn type_is<T: 'static>(&self) -> bool

Returns true if Self is of type T. Read more
Source§

fn as_any_ref(&self) -> &dyn Any
where Self: Sized,

Upcasts &self as &dyn Any. Read more
Source§

fn as_any_mut(&mut self) -> &mut dyn Any
where Self: Sized,

Upcasts &mut self as &mut dyn Any. Read more
Source§

fn as_any_box(self: Box<Self>) -> Box<dyn Any>
where Self: Sized,

Upcasts Box<self> as Box<dyn Any>. Read more
Source§

fn downcast_ref<T: 'static>(&self) -> Option<&T> ⓘ

Available on crate feature unsafe_layout only.
Returns some shared reference to the inner value if it is of type T. Read more
Source§

fn downcast_mut<T: 'static>(&mut self) -> Option<&mut T> ⓘ

Available on crate feature unsafe_layout only.
Returns some exclusive reference to the inner value if it is of type T. Read more
Source§

impl<T> ExtMem for T
where T: ?Sized,

Source§

const NEEDS_DROP: bool = _

Know whether dropping values of this type matters, in compile-time.
Source§

fn mem_align_of<T>() -> usize ⓘ

Returns the minimum alignment of the type in bytes. Read more
Source§

fn mem_align_of_val(&self) -> usize ⓘ

Returns the alignment of the pointed-to value in bytes. Read more
Source§

fn mem_size_of<T>() -> usize ⓘ

Returns the size of a type in bytes. Read more
Source§

fn mem_size_of_val(&self) -> usize ⓘ

Returns the size of the pointed-to value in bytes. Read more
Source§

fn mem_copy(&self) -> Self
where Self: Copy,

Bitwise-copies a value. Read more
Source§

fn mem_needs_drop(&self) -> bool

Returns true if dropping values of this type matters. Read more
Source§

fn mem_drop(self)
where Self: Sized,

Drops self by running its destructor. Read more
Source§

fn mem_forget(self)
where Self: Sized,

Forgets about self without running its destructor. Read more
Source§

fn mem_replace(&mut self, other: Self) -> Self
where Self: Sized,

Replaces self with other, returning the previous value of self. Read more
Source§

fn mem_take(&mut self) -> Self
where Self: Default,

Replaces self with its default value, returning the previous value of self. Read more
Source§

fn mem_swap(&mut self, other: &mut Self)
where Self: Sized,

Swaps the value of self and other without deinitializing either one. Read more
Source§

unsafe fn mem_zeroed<T>() -> T

Available on crate feature unsafe_layout only.
Returns the value of type T represented by the all-zero byte-pattern. Read more
Source§

unsafe fn mem_transmute_copy<Src, Dst>(src: &Src) -> Dst

Available on crate feature unsafe_layout only.
Returns the value of type T represented by the all-zero byte-pattern. Read more
Source§

fn mem_as_bytes(&self) -> &[u8] ⓘ
where Self: Sync + Unpin,

Available on crate feature unsafe_slice only.
View a Sync + Unpin self as &[u8]. Read more
Source§

fn mem_as_bytes_mut(&mut self) -> &mut [u8] ⓘ
where Self: Sync + Unpin,

Available on crate feature unsafe_slice only.
View a Sync + Unpin self as &mut [u8]. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<S> FromSample<S> for S

§

fn from_sample_(s: S) -> S

Source§

impl<T> Hook for T

Source§

fn hook_ref<F>(self, f: F) -> Self
where F: FnOnce(&Self),

Applies a function which takes the parameter by shared reference, and then returns the (possibly) modified owned value. Read more
Source§

fn hook_mut<F>(self, f: F) -> Self
where F: FnOnce(&mut Self),

Applies a function which takes the parameter by exclusive reference, and then returns the (possibly) modified owned value. Read more
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

§

fn into_sample(self) -> T

§

impl<T> LayoutRaw for T

§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError> ⓘ

Returns the layout of the type.
§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize ⓘ

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> Pointee for T

§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

§

fn to_sample_(self) -> U

Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String ⓘ

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error> ⓘ

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error> ⓘ

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

§

impl<T> Ungil for T
where T: Send,